📝 How to Contribute to Documentation
We use docs.page to publish and manage our documentation. All docs are written in Markdown and live in the /docs directory of this repository.
Steps to Contribute
-
Fork and Clone the Repo
Fork this repository on GitHub and clone it locally. -
Edit or Add Markdown Files
- Update existing docs in
/docsor add new.mdfiles as needed. - Follow the structure in
docs/docs.jsonfor navigation.
- Update existing docs in
-
Preview Locally
- Use docs.page local preview or your favorite Markdown previewer to check your changes.
-
Commit and Push
- Commit your changes with a clear message.
- Push to your fork.
-
Open a Pull Request
- Go to GitHub and open a PR from your fork to the main repo.
- Describe your changes and link related issues if any.
-
Review and Merge
- The team will review your PR.
- Once approved, your changes will be published automatically.
Tip:
Keep docs concise, clear, and up-to-date. Use code blocks, headings, and lists for readability.
For more info, see docs.page.