Skip to main content

🤝 Contributing to Docs

We welcome fixes, additions, and improvements to this documentation.

How to Propose Changes​

  1. Fork the repo and create a branch.
  2. Edit Markdown files under docs/.
  3. Preview locally with mkdocs serve.
  4. Open a Pull Request against main.

Style Guide​

  • Use clear, concise English (active voice).
  • Include code snippets for commands.
  • Use admonitions (!!! note) for important points.
  • Keep line length ≤ 120 chars.

Tooling​

  • MkDocs with Material theme.
  • Local preview: pip install mkdocs-material && mkdocs serve.
note

At least one maintainer review is required before merging.