sboulahtit/orion
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: add comprehensive code quality and contributing documentation

Browse Source 
- Add detailed Code Quality guide covering Ruff, mypy, and pytest
- Add Contributing Guide with workflow, standards, and best practices
- Update mkdocs.yml navigation to include new documentation
- Successfully build documentation without errors

New Documentation:
- docs/development/code-quality.md - Complete guide to code quality tools
- docs/development/contributing.md - Contributing guidelines and workflow
- Added Code Quality Dashboard implementation to navigation

Documentation includes:
- Ruff usage and configuration
- mypy type checking
- pytest testing guidelines
- Makefile command reference
- Pre-commit workflow
- IDE integration instructions
- Migration guide from old tools
- Best practices and common issues

Documentation builds cleanly with mkdocs build.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
Samir Boulahtit
2025-11-28 19:43:08 +01:00
parent 238c1ec9b8
commit cde4e8eefc
3 changed files with 348 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
mkdocs.yml
View File

@@ -101,6 +101,9 @@ nav:
# DEVELOPMENT (Shared Development Resources)
# ============================================
- Development:
- Contributing Guide: development/contributing.md
- Code Quality: development/code-quality.md
- Code Quality Dashboard: development/code-quality-dashboard-implementation.md
- Icons Guide: development/icons-guide.md
- Naming Conventions: development/naming-conventions.md
- Auth Dependencies Guide: development/auth-dependencies-guide.md