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

docs: consolidate navigation into 4 main sections

Browse Source 
Reorganize mkdocs navigation from 14 top-level items to 4:

1. Home
2. Getting Started - Installation, quickstart, configuration
3. Documentation - All technical docs (Architecture, API, Backend,
   Frontend, Development, Migrations, Implementation, Testing,
   Deployment, Operations, Troubleshooting)
4. Business - Features, User Guides, Marketing

This provides a cleaner navigation experience with logical grouping
while keeping all content accessible through submenus.

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

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
Samir Boulahtit
2025-12-26 21:15:53 +01:00
parent 5b4f91974e
commit 292c66c623
1 changed files with 171 additions and 187 deletions
Download Patch File Download Diff File Expand all files Collapse all files

100
mkdocs.yml
View File

@@ -16,25 +16,27 @@ nav:
- Getting Started:
- Installation: getting-started/installation.md
- Quick Start: getting-started/quickstart.md
- Configuration: getting-started/configuration.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
- 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
# ============================================
# ARCHITECTURE (System-wide concepts)
# DOCUMENTATION (All Technical)
# ============================================
- Documentation:
# --- Architecture ---
- Architecture:
- Overview: architecture/overview.md
- Marketplace Integration: architecture/marketplace-integration.md
- Architecture Patterns: architecture/architecture-patterns.md
- Multi-Tenant System: architecture/multi-tenant.md
- Marketplace Integration: architecture/marketplace-integration.md
- Language & i18n: architecture/language-i18n.md
- Money Handling: architecture/money-handling.md
- Company-Vendor Management: architecture/company-vendor-management.md
- Multi-Tenant System: architecture/multi-tenant.md
- Middleware Stack: architecture/middleware.md
- Request Flow: architecture/request-flow.md
- Authentication & RBAC: architecture/auth-rbac.md
@@ -55,10 +57,8 @@ nav:
- URL Routing:
- Overview: architecture/url-routing/overview.md
# ============================================
# API DOCUMENTATION (For API Consumers)
# ============================================
- API Documentation:
# --- API Reference ---
- API Reference:
- Overview: api/index.md
- Shop API Reference: api/shop-api-reference.md
- Authentication:
@@ -71,10 +71,8 @@ nav:
- Error Handling: api/error-handling.md
- Rate Limiting: api/rate-limiting.md
# ============================================
# BACKEND (Development Reference)
# ============================================
- Backend Development:
# --- Backend ---
- Backend:
- Overview: backend/overview.md
- Middleware Reference: backend/middleware-reference.md
- RBAC Quick Reference: backend/rbac-quick-reference.md
@@ -83,10 +81,8 @@ nav:
- Admin Integration Guide: backend/admin-integration-guide.md
- Admin Feature Integration: backend/admin-feature-integration.md
# ============================================
# FRONTEND (Development Reference)
# ============================================
- Frontend Development:
# --- Frontend ---
- Frontend:
- Overview: frontend/overview.md
- CDN Fallback Strategy: frontend/cdn-fallback-strategy.md
- Tailwind CSS Build: frontend/tailwind-css.md
@@ -113,9 +109,7 @@ nav:
- Authentication Pages: frontend/shop/authentication-pages.md
- Navigation Flow: frontend/shop/navigation-flow.md
# ============================================
# DEVELOPMENT (Shared Development Resources)
# ============================================
# --- Development ---
- Development:
- Contributing Guide: development/contributing.md
- Code Quality: development/code-quality.md
@@ -129,6 +123,24 @@ nav:
- Customer Authentication:
- Implementation Guide: development/customer-authentication-implementation.md
- Quick Summary: development/customer-auth-summary.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
- Environment Detection: development/environment-detection.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
- Seed Scripts Audit: development/seed-scripts-audit.md
- PyCharm Setup:
- Make Configuration: development/pycharm-configuration-make.md
- Troubleshooting: development/troubleshooting.md
- Synology Repo: development/synology-github-repo.md
# --- Migrations & Implementation ---
- Migrations:
- Database Migrations: development/migration/database-migrations.md
- Language & i18n Implementation: development/migration/language-i18n-implementation.md
@@ -139,6 +151,7 @@ nav:
- Multi-Marketplace Product Architecture: development/migration/multi-marketplace-product-architecture.md
- Product Migration Database Changes: development/migration/product-migration-database-changes.md
- Vendor Operations Expansion: development/migration/vendor-operations-expansion.md
- Implementation Plans:
- Admin Inventory Management: implementation/inventory-admin-migration.md
- Admin Notification System: implementation/admin-notification-system.md
@@ -151,36 +164,15 @@ nav:
- Unified Order View: implementation/unified-order-view.md
- VAT Invoice Feature: implementation/vat-invoice-feature.md
- OMS Feature Plan: implementation/oms-feature-plan.md
- Seed Scripts Audit: development/seed-scripts-audit.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
- 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
- Environment Detection: development/environment-detection.md
- Contributing: development/contributing.md
- PyCharm Setup:
- Make Configuration: development/pycharm-configuration-make.md
- Troubleshooting: development/troubleshooting.md
- Synology Repo: development/synology-github-repo.md
# ============================================
# TESTING
# ============================================
# --- Testing ---
- Testing:
- Testing Guide: testing/testing-guide.md
- Test Maintenance: testing/test-maintenance.md
- Test Structure: testing/test-structure.md
- Vendor API Testing: testing/vendor-api-testing.md
# ============================================
# DEPLOYMENT
# ============================================
# --- Deployment & Operations ---
- Deployment:
- Overview: deployment/index.md
- Docker: deployment/docker.md
@@ -188,17 +180,19 @@ nav:
- Environment Variables: deployment/environment.md
- Stripe Integration: deployment/stripe-integration.md
# ============================================
# OPERATIONS (Platform Health & Monitoring)
# ============================================
- Operations:
- Platform Health: operations/platform-health.md
- Capacity Monitoring: operations/capacity-monitoring.md
- Image Storage: operations/image-storage.md
- Troubleshooting:
- Shop Frontend: troubleshooting/shop-frontend.md
# ============================================
# FEATURES
# BUSINESS (Features, Guides, Marketing)
# ============================================
- Business:
# --- Features ---
- Features:
- Content Management System:
- Overview: features/content-management-system.md
@@ -207,9 +201,7 @@ nav:
- Vendor Landing Pages: features/vendor-landing-pages.md
- Subscription & Billing: features/subscription-billing.md
# ============================================
# USER GUIDES
# ============================================
# --- User Guides ---
- User Guides:
- User Management: guides/user-management.md
- Product Management: guides/product-management.md
@@ -222,15 +214,7 @@ nav:
- Order Integration: guides/letzshop-order-integration.md
- Marketplace API: guides/letzshop-marketplace-api.md
# ============================================
# TROUBLESHOOTING
# ============================================
- Troubleshooting:
- Shop Frontend: troubleshooting/shop-frontend.md
# ============================================
# MARKETING (Business Development)
# ============================================
# --- Marketing ---
- Marketing:
- Overview: marketing/index.md
- Feature List & Roadmap: marketing/features.md