Contributing
Thanks for your interest in contributing! Here's how to get started.
How to Contribute
-
Create a new branch for your changes:
git checkout -b feature/your-feature-name -
Add or edit documentation in the
docs/folder using Markdown -
Update mkdocs.yml if you're adding a new page:
nav: - Home: index.md - Getting Started: getting-started.md - Your New Page: your-page.md -
Test locally:
mkdocs serve -
Commit and push your changes:
git add . git commit -m "Add: description of changes" git push origin feature/your-feature-name -
Create a pull request on GitHub
Building for Production
To build the static site for deployment:
mkdocs build
This generates the site/ folder with all HTML files ready for hosting.
Style Guide
- Use clear, concise language
- Include code examples where helpful
- Keep pages focused on one topic
- Use proper Markdown formatting