- Git
- A Markdown editor (VS Code, Typora, etc.)
- Fork and clone the repository
- Create a branch:
git checkout -b docs/my-change - Make your changes in Markdown
- Submit a pull request
- Use clear, concise language accessible to non-native English speakers
- Include code examples for all API endpoints
- Keep diagrams updated with any architecture changes
- Cross-link between related documents
- Fixing typos, broken links, or outdated information
- Expanding thin sections or adding missing guides
- Translating docs into Swahili, French, Portuguese, or Hindi
- Improving diagrams and architecture visuals