docs: migrate module documentation to single source of truth

Move 39 documentation files from top-level docs/ into each module's docs/ folder, accessible via symlinks from docs/modules/. Create data-model.md files for 10 modules with full schema documentation. Replace originals with redirect stubs. Remove empty guide stubs. Modules migrated: tenancy, billing, loyalty, marketplace, orders, messaging, cms, catalog, inventory, hosting, prospecting. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-03-08 23:38:37 +01:00
parent 2287f4597d
commit f141cc4e6a
140 changed files with 19921 additions and 17723 deletions
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -129,6 +129,7 @@ nav:
    - Development:
      - Contributing Guide: development/contributing.md
      - Creating Modules: development/creating-modules.md
+      - Module Documentation: development/module-documentation.md
      - Code Quality: development/code-quality.md
      - Architecture Rules: development/architecture-rules.md
      - Security Rules: development/security-rules.md
@@ -160,11 +161,91 @@ nav:

    # --- Modules ---
    - Modules:
-      - Loyalty: modules/loyalty.md
+      - Core:
+        - Contracts: modules/contracts/index.md
+        - Core: modules/core/index.md
+        - CMS:
+          - Overview: modules/cms/index.md
+          - Data Model: modules/cms/data-model.md
+          - Architecture: modules/cms/architecture.md
+          - Implementation: modules/cms/implementation.md
+          - Email Templates: modules/cms/email-templates.md
+          - Email Templates Guide: modules/cms/email-templates-guide.md
+          - Media Library: modules/cms/media-library.md
+        - Customers: modules/customers/index.md
+        - Tenancy:
+          - Overview: modules/tenancy/index.md
+          - Data Model: modules/tenancy/data-model.md
+          - RBAC System: modules/tenancy/rbac.md
+          - Store Onboarding: modules/tenancy/onboarding.md
+          - Migration Plan: modules/tenancy/migration.md
+        - Billing:
+          - Overview: modules/billing/index.md
+          - Data Model: modules/billing/data-model.md
+          - Subscription System: modules/billing/subscription-system.md
+          - Feature Gating: modules/billing/feature-gating.md
+          - Tier Management: modules/billing/tier-management.md
+          - Subscription Workflow: modules/billing/subscription-workflow.md
+          - Stripe Integration: modules/billing/stripe-integration.md
+        - Payments: modules/payments/index.md
+        - Messaging:
+          - Overview: modules/messaging/index.md
+          - Data Model: modules/messaging/data-model.md
+          - Architecture: modules/messaging/architecture.md
+          - Notifications: modules/messaging/notifications.md
+          - Email System: modules/messaging/email-system.md
+          - Email Settings: modules/messaging/email-settings.md
+          - Email Settings Implementation: modules/messaging/email-settings-impl.md
+      - Optional:
+        - Analytics: modules/analytics/index.md
+        - Cart: modules/cart/index.md
+        - Catalog:
+          - Overview: modules/catalog/index.md
+          - Data Model: modules/catalog/data-model.md
+          - Architecture: modules/catalog/architecture.md
+        - Checkout: modules/checkout/index.md
+        - Inventory:
+          - Overview: modules/inventory/index.md
+          - Data Model: modules/inventory/data-model.md
+          - User Guide: modules/inventory/user-guide.md
+        - Loyalty:
+          - Overview: modules/loyalty/index.md
+          - Data Model: modules/loyalty/data-model.md
+          - Business Logic: modules/loyalty/business-logic.md
+          - User Journeys: modules/loyalty/user-journeys.md
+          - Program Analysis: modules/loyalty/program-analysis.md
+          - UI Design: modules/loyalty/ui-design.md
+        - Marketplace:
+          - Overview: modules/marketplace/index.md
+          - Data Model: modules/marketplace/data-model.md
+          - Architecture: modules/marketplace/architecture.md
+          - Integration Guide: modules/marketplace/integration-guide.md
+          - Letzshop API: modules/marketplace/api.md
+          - Order Integration: modules/marketplace/order-integration.md
+          - Admin Guide: modules/marketplace/admin-guide.md
+          - Import Improvements: modules/marketplace/import-improvements.md
+          - Job Queue: modules/marketplace/job-queue.md
+        - Orders:
+          - Overview: modules/orders/index.md
+          - Data Model: modules/orders/data-model.md
+          - Architecture: modules/orders/architecture.md
+          - Unified Order View: modules/orders/unified-order-view.md
+          - Order Item Exceptions: modules/orders/exceptions.md
+          - OMS Feature Plan: modules/orders/oms-features.md
+          - VAT Invoicing: modules/orders/vat-invoicing.md
+          - Stock Integration: modules/orders/stock-integration.md
+        - Hosting:
+          - Overview: modules/hosting/index.md
+          - User Journeys: modules/hosting/user-journeys.md
+      - Internal:
+        - Dev Tools: modules/dev_tools/index.md
+        - Monitoring: modules/monitoring/index.md
      - Prospecting:
+        - Overview: modules/prospecting/index.md
        - Database: modules/prospecting/database.md
        - Scoring: modules/prospecting/scoring.md
        - Research Findings: modules/prospecting/research-findings.md
+        - User Journeys: modules/prospecting/user-journeys.md

    # --- Migrations & Implementation ---
    - Migrations:
@@ -242,7 +323,12 @@ nav:
      - Permissions Plan: proposals/plan-perms.md
      - Validator Noqa & Remaining Findings: proposals/validator-noqa-suppressions-and-remaining-findings.md
      - Backward Compatibility Cleanup: proposals/backward-compatibility-cleanup.md
+      - Module Documentation Migration: proposals/module-documentation-migration-plan.md
      - Fix SEC-015 x-html Findings: proposals/fix-1600-sec015-xhtml-findings.md
+      - Google Wallet Local Testing: proposals/google-wallet-local-testing.md
+      - RBAC Cleanup Two-Phase Plan: proposals/rbac-cleanup-two-phase-plan.md
+      - Store Login Platform Detection: proposals/store-login-platform-detection.md
+      - Test API Deps Auth Dependencies: proposals/test-api-deps-auth-dependencies.md

    # --- Archive ---
    - Archive:
@@ -284,14 +370,11 @@ nav:
    # --- User Guides ---
    - User Guides:
      - User Management: guides/user-management.md
-      - Product Management: guides/product-management.md
      - Media Library: guides/media-library.md
      - Inventory Management: guides/inventory-management.md
      - Subscription Tier Management: guides/subscription-tier-management.md
      - Email Settings: guides/email-settings.md
      - Email Templates: guides/email-templates.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