Create Documentation ✍️
Opened this issue · 2 comments
prnv404 commented
Description 📑
This issue is to request documentation for the LeetCode Tracker project. The documentation should provide clear and comprehensive information about the project, its purpose, functionality, and how to use it effectively.
Documentation Requirements
The documentation should cover the following aspects:
- Project Overview: A brief introduction to the LeetCode Tracker project and its objectives.
- Installation: Step-by-step instructions on how to set up the project environment.
- Usage Guide: A detailed guide on how to use the API's working, including the purpose of the crone job and daily,weekly metrics, etc..
- Contributor Guidelines: Information on how others can contribute to the project.
- Troubleshooting: Common issues users might encounter and their solutions.
- Contact Information: How to reach out for support or questions related to the project.
Guide 🎈
We are using Docsify to create documentation
installation
npm i docsify-cli -g
docsify serve docs
It will open the docs in the browser with a specified URL
Refer to the documentation of Docsify