uv pip install -r requirements.txt
- Install dependenciesuv run mkdocs serve
- Run local development server
- Primarily a documentation project using MkDocs
- Documentation files in Markdown format in
/docs
directory - Custom MkDocs configuration in
mkdocs.yml
- Primarily Markdown files following MkDocs/Material formatting
- Python scripts follow standard Python conventions:
- Use spaces for indentation (4 spaces)
- Use descriptive variable names in snake_case
- Include docstrings and comments when needed
- Create issues for bugs or suggestions
- Follow guidelines in CONTRIBUTING.md
- Submit pull requests for review