refactor: standardize markdown file naming to kebab-case convention
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:
@@ -1253,7 +1253,7 @@ For a condensed cheat sheet of authentication patterns, see [Authentication Quic
|
||||
|
||||
## Related Documentation
|
||||
|
||||
- [RBAC System](RBAC.md) - Role-based access control and permissions
|
||||
- [RBAC System](rbac.md) - Role-based access control and permissions
|
||||
- [Architecture Overview](../architecture/auth-rbac.md) - System-wide authentication architecture
|
||||
- [Backend Development](../backend/overview.md) - Backend development guide
|
||||
- [API Reference](../backend/middleware-reference.md) - Auto-generated API documentation
|
||||
|
||||
@@ -287,6 +287,6 @@ async def invalid_token_handler(request, exc):
|
||||
## Related Documentation
|
||||
|
||||
- [Authentication](authentication.md) - Authentication-related exceptions
|
||||
- [RBAC](RBAC.md) - Authorization and permission exceptions
|
||||
- [RBAC](rbac.md) - Authorization and permission exceptions
|
||||
- [Rate Limiting](rate-limiting.md) - Rate limit error handling
|
||||
- [Testing Guide](../testing/testing-guide.md) - Testing error scenarios
|
||||
|
||||
@@ -832,7 +832,7 @@ POST /api/v1/shop/auth/login
|
||||
- ✅ Cleaner URLs (~40% shorter)
|
||||
- ✅ Same functionality, better architecture
|
||||
|
||||
**See:** [API Migration Status](../architecture/API_MIGRATION_STATUS.md)
|
||||
**See:** [API Migration Status](../architecture/api-migration-status.md)
|
||||
|
||||
---
|
||||
|
||||
@@ -908,4 +908,4 @@ For live API testing and exploration:
|
||||
|
||||
---
|
||||
|
||||
**Questions?** See the [API Migration Status](../architecture/API_MIGRATION_STATUS.md) or [Shop Architecture Guide](../frontend/shop/architecture.md).
|
||||
**Questions?** See the [API Migration Status](../architecture/api-migration-status.md) or [Shop Architecture Guide](../frontend/shop/architecture.md).
|
||||
|
||||
@@ -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)
|
||||
@@ -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:
|
||||
@@ -309,6 +309,6 @@ For testing examples, see the [Testing Guide](../testing/testing-guide.md).
|
||||
## Related Documentation
|
||||
|
||||
- [Authentication Guide](../api/authentication.md) - User authentication and JWT tokens
|
||||
- [RBAC Documentation](../api/RBAC.md) - Role-based access control
|
||||
- [RBAC Documentation](../api/rbac.md) - Role-based access control
|
||||
- [Error Handling](../api/error-handling.md) - Exception handling patterns
|
||||
- [Rate Limiting](../api/rate-limiting.md) - API rate limiting strategies
|
||||
|
||||
@@ -510,4 +510,4 @@ ENVIRONMENT=development|staging|production
|
||||
|
||||
**Print and keep at your desk!**
|
||||
|
||||
For full documentation: See [RBAC Developer Guide](../api/RBAC.md)
|
||||
For full documentation: See [RBAC Developer Guide](../api/rbac.md)
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
# Customer Authentication - Quick Summary
|
||||
|
||||
**Date**: 2025-11-24
|
||||
**Full Documentation**: [CUSTOMER_AUTHENTICATION_IMPLEMENTATION.md](CUSTOMER_AUTHENTICATION_IMPLEMENTATION.md)
|
||||
**Full Documentation**: [customer-authentication-implementation.md](customer-authentication-implementation.md)
|
||||
|
||||
## What Was Implemented
|
||||
|
||||
@@ -324,5 +324,5 @@ Migration failures will halt deployment to prevent data corruption.
|
||||
## Further Reading
|
||||
|
||||
- [Alembic Official Documentation](https://alembic.sqlalchemy.org/)
|
||||
- [Database Setup Guide](../getting-started/DATABASE_SETUP_GUIDE.md)
|
||||
- [Database Setup Guide](../getting-started/database-setup-guide.md)
|
||||
- [Deployment Guide](../deployment/production.md)
|
||||
|
||||
@@ -242,6 +242,6 @@ make help-db # Database-specific help
|
||||
```
|
||||
|
||||
**Documentation**:
|
||||
- `DATABASE_INIT_GUIDE.md` - Detailed guide
|
||||
- `database-init-guide.md` - Detailed guide
|
||||
- `MIGRATION_GUIDE.md` - Migration from old system
|
||||
- `README.md` - Project overview
|
||||
@@ -349,7 +349,7 @@ For detailed information about the design patterns used across all frontends, se
|
||||
- **[Pagination System](shared/pagination.md)** - Pagination implementation
|
||||
- **[Sidebar Navigation](shared/sidebar.md)** - Sidebar setup guide
|
||||
- **[Logging System](shared/logging.md)** - Frontend logging configuration
|
||||
- **[Icons Guide](../development/icons_guide.md)** - Icon system usage
|
||||
- **[Icons Guide](../development/icons-guide.md)** - Icon system usage
|
||||
|
||||
---
|
||||
|
||||
@@ -497,7 +497,7 @@ For detailed information about the design patterns used across all frontends, se
|
||||
2. Study the page template guide for that frontend
|
||||
3. Review existing code examples (`dashboard.js` is the best)
|
||||
4. Check the [Shared Components](shared/ui-components.md) documentation
|
||||
5. Review the [Icons Guide](../development/icons_guide.md)
|
||||
5. Review the [Icons Guide](../development/icons-guide.md)
|
||||
6. Copy templates and start building!
|
||||
|
||||
Questions? Check the detailed architecture docs or review existing implementations in the codebase.
|
||||
|
||||
@@ -184,7 +184,7 @@ Existing pages are never overwritten.
|
||||
For complete CMS documentation, see:
|
||||
- [CMS Feature Documentation](../features/content-management-system.md)
|
||||
- [CMS Implementation Guide](../features/cms-implementation-guide.md)
|
||||
- [Database Seeder Guide](../development/database-seeder/DATABASE_SEEDER_DOCUMENTATION.md)
|
||||
- [Database Seeder Guide](../development/database-seeder/database-seeder-documentation.md)
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
|
||||
@@ -667,4 +667,4 @@ def test_endpoint(self):
|
||||
- [Testing Guide](testing-guide.md) - Testing strategy and best practices
|
||||
- [Test Maintenance](test-maintenance.md) - Maintaining test quality
|
||||
- [API Authentication](../api/authentication.md) - Authentication documentation
|
||||
- [RBAC](../api/RBAC.md) - Role-based access control
|
||||
- [RBAC](../api/rbac.md) - Role-based access control
|
||||
|
||||
30
mkdocs.yml
30
mkdocs.yml
@@ -18,8 +18,8 @@ nav:
|
||||
- Quick Start: getting-started/quickstart.md
|
||||
- Database Setup:
|
||||
- Overview: getting-started/database-setup.md
|
||||
- Complete Setup Guide: getting-started/DATABASE_SETUP_GUIDE.md
|
||||
- Quick Reference: getting-started/DATABASE_QUICK_REFERENCE.md
|
||||
- Complete Setup Guide: getting-started/database-setup-guide.md
|
||||
- Quick Reference: getting-started/database-quick-reference.md
|
||||
- CMS Quick Start: getting-started/cms-quick-start.md
|
||||
- Platform Homepage Quick Start: getting-started/platform-homepage-quick-start.md
|
||||
- Configuration: getting-started/configuration.md
|
||||
@@ -35,8 +35,8 @@ nav:
|
||||
- Request Flow: architecture/request-flow.md
|
||||
- Authentication & RBAC: architecture/auth-rbac.md
|
||||
- API Consolidation:
|
||||
- Proposal: architecture/API_CONSOLIDATION_PROPOSAL.md
|
||||
- Migration Status: architecture/API_MIGRATION_STATUS.md
|
||||
- Proposal: architecture/api-consolidation-proposal.md
|
||||
- Migration Status: architecture/api-migration-status.md
|
||||
- Diagrams:
|
||||
- Multi-Tenant Diagrams: architecture/diagrams/multitenant-diagrams.md
|
||||
- Vendor Domain Diagrams: architecture/diagrams/vendor-domain-diagrams.md
|
||||
@@ -57,7 +57,7 @@ nav:
|
||||
- Quick Reference: api/authentication-quick-reference.md
|
||||
- Flow Diagrams: api/authentication-flow-diagrams.md
|
||||
- RBAC:
|
||||
- Developer Guide: api/RBAC.md
|
||||
- Developer Guide: api/rbac.md
|
||||
- Visual Guide: api/rbac-visual-guide.md
|
||||
- Error Handling: api/error-handling.md
|
||||
- Rate Limiting: api/rate-limiting.md
|
||||
@@ -101,23 +101,23 @@ nav:
|
||||
# DEVELOPMENT (Shared Development Resources)
|
||||
# ============================================
|
||||
- Development:
|
||||
- Icons Guide: development/icons_guide.md
|
||||
- Icons Guide: development/icons-guide.md
|
||||
- Naming Conventions: development/naming-conventions.md
|
||||
- Auth Dependencies Guide: development/AUTH_DEPENDENCIES_GUIDE.md
|
||||
- Auth Dependencies Guide: development/auth-dependencies-guide.md
|
||||
- Customer Authentication:
|
||||
- Implementation Guide: development/CUSTOMER_AUTHENTICATION_IMPLEMENTATION.md
|
||||
- Quick Summary: development/CUSTOMER_AUTH_SUMMARY.md
|
||||
- Implementation Guide: development/customer-authentication-implementation.md
|
||||
- Quick Summary: development/customer-auth-summary.md
|
||||
- Database Migrations: development/database-migrations.md
|
||||
- Database Seeder:
|
||||
- Documentation: development/database-seeder/DATABASE_SEEDER_DOCUMENTATION.md
|
||||
- Makefile Guide: development/database-seeder/MAKEFILE_DATABASE_SEEDER.md
|
||||
- Init Guide: development/database-seeder/DATABASE_INIT_GUIDE.md
|
||||
- Quick Reference: development/database-seeder/DATABASE_QUICK_REFERENCE_GUIDE.md
|
||||
- Documentation: development/database-seeder/database-seeder-documentation.md
|
||||
- Makefile Guide: development/database-seeder/makefile-database-seeder.md
|
||||
- Init Guide: development/database-seeder/database-init-guide.md
|
||||
- Quick Reference: development/database-seeder/database-quick-reference-guide.md
|
||||
- Exception Handling: development/exception-handling.md
|
||||
- Frontend Exception Handling: development/frontend-exception-handling.md
|
||||
- Error Rendering:
|
||||
- Developer Documentation: development/error-rendering/ERROR_RENDERING_DEVELOPER_DOCUMENTATION.md
|
||||
- Flow Diagram: development/error-rendering/HTML_ERROR_RENDERING_FLOW_DIAGRAM.md
|
||||
- Developer Documentation: development/error-rendering/error-rendering-developer-documentation.md
|
||||
- Flow Diagram: development/error-rendering/html-error-rendering-flow-diagram.md
|
||||
- Environment Detection: development/environment-detection.md
|
||||
- Contributing: development/contributing.md
|
||||
- PyCharm Setup:
|
||||
|
||||
Reference in New Issue
Block a user