From 292c66c6232f59d6cdaa40695f912a9e52d44e85 Mon Sep 17 00:00:00 2001 From: Samir Boulahtit Date: Fri, 26 Dec 2025 21:15:53 +0100 Subject: [PATCH] docs: consolidate navigation into 4 main sections MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 --- mkdocs.yml | 358 +++++++++++++++++++++++++---------------------------- 1 file changed, 171 insertions(+), 187 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index 75fdeaeb..2cbc7a95 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -16,119 +16,131 @@ 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) # ============================================ - - Architecture: - - Overview: architecture/overview.md - - Marketplace Integration: architecture/marketplace-integration.md - - Architecture Patterns: architecture/architecture-patterns.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 - - Frontend Structure: architecture/frontend-structure.md - - Models Structure: architecture/models-structure.md - - Background Tasks: architecture/background-tasks.md - - Capacity Planning: architecture/capacity-planning.md - - API Consolidation: - - Proposal: architecture/api-consolidation-proposal.md - - Migration Status: architecture/api-migration-status.md - - Architecture Violations Status: architecture/architecture-violations-status.md - - Diagrams: - - Multi-Tenant Diagrams: architecture/diagrams/multitenant-diagrams.md - - Vendor Domain Diagrams: architecture/diagrams/vendor-domain-diagrams.md - - Theme System: - - Overview: architecture/theme-system/overview.md - - Theme Presets: architecture/theme-system/presets.md - - URL Routing: - - Overview: architecture/url-routing/overview.md + - Documentation: + # --- Architecture --- + - Architecture: + - Overview: architecture/overview.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 + - Middleware Stack: architecture/middleware.md + - Request Flow: architecture/request-flow.md + - Authentication & RBAC: architecture/auth-rbac.md + - Frontend Structure: architecture/frontend-structure.md + - Models Structure: architecture/models-structure.md + - Background Tasks: architecture/background-tasks.md + - Capacity Planning: architecture/capacity-planning.md + - API Consolidation: + - Proposal: architecture/api-consolidation-proposal.md + - Migration Status: architecture/api-migration-status.md + - Architecture Violations Status: architecture/architecture-violations-status.md + - Diagrams: + - Multi-Tenant Diagrams: architecture/diagrams/multitenant-diagrams.md + - Vendor Domain Diagrams: architecture/diagrams/vendor-domain-diagrams.md + - Theme System: + - Overview: architecture/theme-system/overview.md + - Theme Presets: architecture/theme-system/presets.md + - URL Routing: + - Overview: architecture/url-routing/overview.md - # ============================================ - # API DOCUMENTATION (For API Consumers) - # ============================================ - - API Documentation: - - Overview: api/index.md - - Shop API Reference: api/shop-api-reference.md - - Authentication: - - Guide: api/authentication.md - - Quick Reference: api/authentication-quick-reference.md - - Flow Diagrams: api/authentication-flow-diagrams.md - - RBAC: - - Developer Guide: api/rbac.md - - Visual Guide: api/rbac-visual-guide.md - - Error Handling: api/error-handling.md - - Rate Limiting: api/rate-limiting.md + # --- API Reference --- + - API Reference: + - Overview: api/index.md + - Shop API Reference: api/shop-api-reference.md + - Authentication: + - Guide: api/authentication.md + - Quick Reference: api/authentication-quick-reference.md + - Flow Diagrams: api/authentication-flow-diagrams.md + - RBAC: + - Developer Guide: api/rbac.md + - Visual Guide: api/rbac-visual-guide.md + - Error Handling: api/error-handling.md + - Rate Limiting: api/rate-limiting.md - # ============================================ - # BACKEND (Development Reference) - # ============================================ - - Backend Development: - - Overview: backend/overview.md - - Middleware Reference: backend/middleware-reference.md - - RBAC Quick Reference: backend/rbac-quick-reference.md - - Vendor RBAC: backend/vendor-rbac.md - - Vendor-in-Token Architecture: backend/vendor-in-token-architecture.md - - Admin Integration Guide: backend/admin-integration-guide.md - - Admin Feature Integration: backend/admin-feature-integration.md + # --- Backend --- + - Backend: + - Overview: backend/overview.md + - Middleware Reference: backend/middleware-reference.md + - RBAC Quick Reference: backend/rbac-quick-reference.md + - Vendor RBAC: backend/vendor-rbac.md + - Vendor-in-Token Architecture: backend/vendor-in-token-architecture.md + - Admin Integration Guide: backend/admin-integration-guide.md + - Admin Feature Integration: backend/admin-feature-integration.md - # ============================================ - # FRONTEND (Development Reference) - # ============================================ - - Frontend Development: - - Overview: frontend/overview.md - - CDN Fallback Strategy: frontend/cdn-fallback-strategy.md - - Tailwind CSS Build: frontend/tailwind-css.md - - Shared Components: - - Component Standards: frontend/shared/component-standards.md - - Jinja Macros Library: frontend/shared/jinja-macros.md - - UI Components: frontend/shared/ui-components.md - - UI Components Quick Reference: frontend/shared/ui-components-quick-reference.md - - Pagination: frontend/shared/pagination.md - - Pagination Quick Start: frontend/shared/pagination-quick-start.md - - Platform Settings: frontend/shared/platform-settings.md - - Sidebar Implementation: frontend/shared/sidebar.md - - Logging System: frontend/shared/logging.md - - Admin Frontend: - - Architecture: frontend/admin/architecture.md - - Page Templates: frontend/admin/page-templates.md - - Vendor Frontend: - - Architecture: frontend/vendor/architecture.md - - Page Templates: frontend/vendor/page-templates.md - - Shop Frontend: - - Architecture: frontend/shop/architecture.md - - Page Templates: frontend/shop/page-templates.md - - E-commerce Components Proposal: frontend/shop/ecommerce-components-proposal.md - - Authentication Pages: frontend/shop/authentication-pages.md - - Navigation Flow: frontend/shop/navigation-flow.md + # --- Frontend --- + - Frontend: + - Overview: frontend/overview.md + - CDN Fallback Strategy: frontend/cdn-fallback-strategy.md + - Tailwind CSS Build: frontend/tailwind-css.md + - Shared Components: + - Component Standards: frontend/shared/component-standards.md + - Jinja Macros Library: frontend/shared/jinja-macros.md + - UI Components: frontend/shared/ui-components.md + - UI Components Quick Reference: frontend/shared/ui-components-quick-reference.md + - Pagination: frontend/shared/pagination.md + - Pagination Quick Start: frontend/shared/pagination-quick-start.md + - Platform Settings: frontend/shared/platform-settings.md + - Sidebar Implementation: frontend/shared/sidebar.md + - Logging System: frontend/shared/logging.md + - Admin Frontend: + - Architecture: frontend/admin/architecture.md + - Page Templates: frontend/admin/page-templates.md + - Vendor Frontend: + - Architecture: frontend/vendor/architecture.md + - Page Templates: frontend/vendor/page-templates.md + - Shop Frontend: + - Architecture: frontend/shop/architecture.md + - Page Templates: frontend/shop/page-templates.md + - E-commerce Components Proposal: frontend/shop/ecommerce-components-proposal.md + - Authentication Pages: frontend/shop/authentication-pages.md + - Navigation Flow: frontend/shop/navigation-flow.md - # ============================================ - # DEVELOPMENT (Shared Development Resources) - # ============================================ - - Development: - - Contributing Guide: development/contributing.md - - Code Quality: development/code-quality.md - - Architecture Rules: development/architecture-rules.md - - Security Rules: development/security-rules.md - - Performance Rules: development/performance-rules.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 - - Customer Authentication: - - Implementation Guide: development/customer-authentication-implementation.md - - Quick Summary: development/customer-auth-summary.md + # --- Development --- + - Development: + - Contributing Guide: development/contributing.md + - Code Quality: development/code-quality.md + - Architecture Rules: development/architecture-rules.md + - Security Rules: development/security-rules.md + - Performance Rules: development/performance-rules.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 + - 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,96 +164,67 @@ 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 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 & Operations --- + - Deployment: + - Overview: deployment/index.md + - Docker: deployment/docker.md + - Production: deployment/production.md + - Environment Variables: deployment/environment.md + - Stripe Integration: deployment/stripe-integration.md + + - 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 # ============================================ - # TESTING + # BUSINESS (Features, Guides, Marketing) # ============================================ - - 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 + - Business: + # --- Features --- + - Features: + - Content Management System: + - Overview: features/content-management-system.md + - Implementation Guide: features/cms-implementation-guide.md + - Platform Homepage: features/platform-homepage.md + - Vendor Landing Pages: features/vendor-landing-pages.md + - Subscription & Billing: features/subscription-billing.md - # ============================================ - # DEPLOYMENT - # ============================================ - - Deployment: - - Overview: deployment/index.md - - Docker: deployment/docker.md - - Production: deployment/production.md - - Environment Variables: deployment/environment.md - - Stripe Integration: deployment/stripe-integration.md + # --- User Guides --- + - User Guides: + - User Management: guides/user-management.md + - Product Management: guides/product-management.md + - Inventory Management: guides/inventory-management.md + - Shop Setup: guides/shop-setup.md + - CSV Import: guides/csv-import.md + - Marketplace Integration: guides/marketplace-integration.md + - Letzshop: + - Admin Management: guides/letzshop-admin-management.md + - Order Integration: guides/letzshop-order-integration.md + - Marketplace API: guides/letzshop-marketplace-api.md - # ============================================ - # OPERATIONS (Platform Health & Monitoring) - # ============================================ - - Operations: - - Platform Health: operations/platform-health.md - - Capacity Monitoring: operations/capacity-monitoring.md - - Image Storage: operations/image-storage.md - - # ============================================ - # FEATURES - # ============================================ - - Features: - - Content Management System: - - Overview: features/content-management-system.md - - Implementation Guide: features/cms-implementation-guide.md - - Platform Homepage: features/platform-homepage.md - - Vendor Landing Pages: features/vendor-landing-pages.md - - Subscription & Billing: features/subscription-billing.md - - # ============================================ - # USER GUIDES - # ============================================ - - User Guides: - - User Management: guides/user-management.md - - Product Management: guides/product-management.md - - Inventory Management: guides/inventory-management.md - - Shop Setup: guides/shop-setup.md - - CSV Import: guides/csv-import.md - - Marketplace Integration: guides/marketplace-integration.md - - Letzshop: - - Admin Management: guides/letzshop-admin-management.md - - 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: - - Overview: marketing/index.md - - Feature List & Roadmap: marketing/features.md - - Pricing Strategy: marketing/pricing.md - - Strategy: - - Back-Office Positioning: marketing/strategy/back-office-positioning.md - - Customer & Marketing: marketing/strategy/customer-marketing-positioning.md - - Outreach Templates: - - Letzshop Automation: marketing/outreach/letzshop-automation.md - - Website Vendors: marketing/outreach/website-vendors.md + # --- Marketing --- + - Marketing: + - Overview: marketing/index.md + - Feature List & Roadmap: marketing/features.md + - Pricing Strategy: marketing/pricing.md + - Strategy: + - Back-Office Positioning: marketing/strategy/back-office-positioning.md + - Customer & Marketing: marketing/strategy/customer-marketing-positioning.md + - Outreach Templates: + - Letzshop Automation: marketing/outreach/letzshop-automation.md + - Website Vendors: marketing/outreach/website-vendors.md # Theme configuration theme: @@ -251,7 +235,7 @@ theme: toggle: icon: material/brightness-auto name: Switch to light mode - + # Palette toggle for light mode - media: "(prefers-color-scheme: light)" scheme: default @@ -356,4 +340,4 @@ extra: link: https://github.com/yourusername # Copyright -copyright: Copyright © 2024-2025 Wizamart Team \ No newline at end of file +copyright: Copyright © 2024-2025 Wizamart Team