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

refactor: standardize markdown file naming to kebab-case convention

Browse Source 
Renamed all documentation files to follow kebab-case naming standard:
- UPPERCASE files → lowercase (e.g., RBAC.md → rbac.md)
- snake_case files → kebab-case (e.g., icons_guide.md → icons-guide.md)
- SCREAMING_SNAKE_CASE → kebab-case (e.g., DATABASE_SETUP_GUIDE.md → database-setup-guide.md)

Files renamed (15 total):
API Documentation:
  - api/RBAC.md → api/rbac.md

Architecture:
  - architecture/API_CONSOLIDATION_PROPOSAL.md → api-consolidation-proposal.md
  - architecture/API_MIGRATION_STATUS.md → api-migration-status.md

Development:
  - development/AUTH_DEPENDENCIES_GUIDE.md → auth-dependencies-guide.md
  - development/CUSTOMER_AUTHENTICATION_IMPLEMENTATION.md → customer-authentication-implementation.md
  - development/CUSTOMER_AUTH_SUMMARY.md → customer-auth-summary.md
  - development/icons_guide.md → icons-guide.md

Database Seeder:
  - database-seeder/DATABASE_INIT_GUIDE.md → database-init-guide.md
  - database-seeder/DATABASE_QUICK_REFERENCE_GUIDE.md → database-quick-reference-guide.md
  - database-seeder/DATABASE_SEEDER_DOCUMENTATION.md → database-seeder-documentation.md
  - database-seeder/MAKEFILE_DATABASE_SEEDER.md → makefile-database-seeder.md

Error Rendering:
  - error-rendering/ERROR_RENDERING_DEVELOPER_DOCUMENTATION.md → error-rendering-developer-documentation.md
  - error-rendering/HTML_ERROR_RENDERING_FLOW_DIAGRAM.md → html-error-rendering-flow-diagram.md

Getting Started:
  - getting-started/DATABASE_QUICK_REFERENCE.md → database-quick-reference.md
  - getting-started/DATABASE_SETUP_GUIDE.md → database-setup-guide.md

Updates:
- Updated all references in mkdocs.yml
- Updated all cross-references in markdown files
- Verified mkdocs builds without warnings or errors

Standard: Use kebab-case (lowercase-with-hyphens) for all markdown files

🤖 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 07:58:33 +01:00
parent 1e720ae0e5
commit 3c7af0ccdf
25 changed files with 33 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/architecture/API_CONSOLIDATION_PROPOSAL.md → docs/architecture/api-consolidation-proposal.md
View File

@@ -436,7 +436,7 @@ Should we:
## References
- [Authentication Dependencies Guide](../development/AUTH_DEPENDENCIES_GUIDE.md)
- [Authentication Dependencies Guide](../development/auth-dependencies-guide.md)
- [Multi-Tenant Architecture](./multi-tenant.md)
- [Middleware Stack Documentation](./middleware.md)
- [URL Routing Overview](./url-routing/overview.md)

8
docs/architecture/API_MIGRATION_STATUS.md → docs/architecture/api-migration-status.md
View File

@@ -160,8 +160,8 @@ app/exceptions/error_renderer.py → Added base_url calculation for shop con
app/routes/vendor_pages.py → Added CMS route handler
app/templates/shop/errors/*.html → Fixed links to use base_url
docs/architecture/
├── API_CONSOLIDATION_PROPOSAL.md → Analysis & recommendation
└── API_MIGRATION_STATUS.md → This file
├── api-consolidation-proposal.md → Analysis & recommendation
└── api-migration-status.md → This file
```
---
@@ -427,8 +427,8 @@ Migration is considered successful when:
## Contact & Support
**Questions?** Check:
- [API Consolidation Proposal](./API_CONSOLIDATION_PROPOSAL.md) - Full analysis
- [Authentication Dependencies Guide](../development/AUTH_DEPENDENCIES_GUIDE.md) - Auth patterns
- [API Consolidation Proposal](./api-consolidation-proposal.md) - Full analysis
- [Authentication Dependencies Guide](../development/auth-dependencies-guide.md) - Auth patterns
- [Middleware Documentation](./middleware.md) - How middleware works
**Issues?** Review: