📝 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

  1. Fork and Clone the Repo
    Fork this repository on GitHub and clone it locally.

  2. Edit or Add Markdown Files

    • Update existing docs in /docs or add new .md files as needed.
    • Follow the structure in docs/docs.json for navigation.
  3. Preview Locally

  4. Commit and Push

    • Commit your changes with a clear message.
    • Push to your fork.
  5. 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.
  6. 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.