site_name: Wizamart Platform Documentation site_description: Complete documentation for the Wizamart multi-tenant e-commerce platform site_author: Wizamart Team site_url: https://yourusername.github.io/wizamart/ repo_name: wizamart-platform repo_url: https://github.com/yourusername/wizamart-platform edit_uri: edit/main/docs/ nav: - Home: index.md # ============================================ # GETTING STARTED # ============================================ - Getting Started: - Installation: getting-started/installation.md - 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 - 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) # ============================================ - Architecture: - Overview: architecture/overview.md - Marketplace Integration: architecture/marketplace-integration.md - Architecture Patterns: architecture/architecture-patterns.md - Language & i18n: architecture/language-i18n.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 - 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 # ============================================ # 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 # ============================================ # 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 - 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 - 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 - Migrations: - Database Migrations: development/migration/database-migrations.md - Language & i18n Implementation: development/migration/language-i18n-implementation.md - Tailwind CSS Migration: development/migration/tailwind-migration-plan.md - Makefile Refactoring: development/migration/makefile-refactoring-complete.md - SVC-006 Migration Plan: development/migration/svc-006-migration-plan.md - Vendor Contact Inheritance: development/migration/vendor-contact-inheritance.md - Multi-Marketplace Product Architecture: development/migration/multi-marketplace-product-architecture.md - Product Migration Database Changes: development/migration/product-migration-database-changes.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 # ============================================ - Deployment: - Overview: deployment/index.md - Docker: deployment/docker.md - Production: deployment/production.md - Environment Variables: deployment/environment.md - Stripe Integration: deployment/stripe-integration.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 # ============================================ # USER GUIDES # ============================================ - User Guides: - User Management: guides/user-management.md - Product Management: guides/product-management.md - Shop Setup: guides/shop-setup.md - CSV Import: guides/csv-import.md - Marketplace Integration: guides/marketplace-integration.md - Letzshop: - Order Integration: guides/letzshop-order-integration.md - Marketplace API: guides/letzshop-marketplace-api.md # ============================================ # TROUBLESHOOTING # ============================================ - Troubleshooting: - Shop Frontend: troubleshooting/shop-frontend.md # Theme configuration theme: name: material palette: # Palette toggle for automatic mode - media: "(prefers-color-scheme)" toggle: icon: material/brightness-auto name: Switch to light mode # Palette toggle for light mode - media: "(prefers-color-scheme: light)" scheme: default primary: blue accent: blue toggle: icon: material/brightness-7 name: Switch to dark mode # Palette toggle for dark mode - media: "(prefers-color-scheme: dark)" scheme: slate primary: blue accent: blue toggle: icon: material/brightness-4 name: Switch to system preference features: - navigation.tabs - navigation.tabs.sticky - navigation.sections - navigation.expand - navigation.path - navigation.indexes - toc.follow - navigation.top - search.suggest - search.highlight - content.tabs.link - content.code.annotation - content.code.copy - content.action.edit - content.action.view icon: repo: fontawesome/brands/github # Plugins plugins: - search: separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])' - mkdocstrings: handlers: python: options: docstring_style: google show_source: true show_root_heading: true show_root_toc_entry: false merge_init_into_class: true # Markdown extensions markdown_extensions: - abbr - admonition - attr_list - def_list - footnotes - md_in_html - toc: permalink: true - pymdownx.arithmatex: generic: true - pymdownx.betterem: smart_enable: all - pymdownx.caret - pymdownx.details - pymdownx.emoji: emoji_generator: !!python/name:material.extensions.emoji.to_svg emoji_index: !!python/name:material.extensions.emoji.twemoji - pymdownx.highlight: anchor_linenums: true line_spans: __span pygments_lang_class: true - pymdownx.inlinehilite - pymdownx.keys - pymdownx.magiclink: normalize_issue_symbols: true repo_url_shorthand: true user: yourusername repo: letzshop-import - pymdownx.mark - pymdownx.smartsymbols - pymdownx.snippets - pymdownx.superfences: custom_fences: - name: mermaid class: mermaid format: !!python/name:pymdownx.superfences.fence_code_format - pymdownx.tabbed: alternate_style: true combine_header_slug: true - pymdownx.tasklist: custom_checkbox: true - pymdownx.tilde # Footer extra: social: - icon: fontawesome/brands/github link: https://github.com/yourusername # Copyright copyright: Copyright © 2024-2025 Wizamart Team