revamping documentation
This commit is contained in:
150
mkdocs.yml
150
mkdocs.yml
@@ -1,48 +1,142 @@
|
||||
site_name: Letzshop Import Documentation
|
||||
site_description: Complete documentation for the Letzshop Import application
|
||||
site_author: Letzshop Team
|
||||
site_url: https://yourusername.github.io/letzshop-import/
|
||||
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: letzshop-import
|
||||
repo_url: https://github.com/yourusername/letzshop-import
|
||||
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: getting-started/database-setup.md # NEW
|
||||
- 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
|
||||
- Configuration: getting-started/configuration.md
|
||||
- API:
|
||||
|
||||
# ============================================
|
||||
# ARCHITECTURE (System-wide concepts)
|
||||
# ============================================
|
||||
- Architecture:
|
||||
- Overview: architecture/overview.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
|
||||
- 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
|
||||
- Authentication: api/authentication.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
|
||||
- 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
|
||||
- Shared Components:
|
||||
- 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
|
||||
|
||||
# ============================================
|
||||
# DEVELOPMENT (Shared Development Resources)
|
||||
# ============================================
|
||||
- Development:
|
||||
- Icons Guide: development/icons_guide.md
|
||||
- Naming Conventions: development/naming-conventions.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
|
||||
- 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
|
||||
|
||||
# ============================================
|
||||
# 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
|
||||
- Shop Setup: guides/shop-setup.md
|
||||
- CSV Import: guides/csv-import.md
|
||||
- Marketplace Integration: guides/marketplace-integration.md
|
||||
- Testing:
|
||||
- Testing Guide: testing/testing-guide.md
|
||||
- Test Maintenance: testing/test-maintenance.md
|
||||
- Development:
|
||||
- Architecture: development/architecture.md
|
||||
- Database Schema: development/database-schema.md
|
||||
- Database Migrations: development/database-migrations.md # NEW
|
||||
- Services: development/services.md
|
||||
- Contributing: development/contributing.md
|
||||
- Pycharm configuration: development/pycharm-configuration.md
|
||||
- Pycharm configuration: development/exception-handling.md
|
||||
- Pycharm configuration: development/frontend-exception-handling.md
|
||||
- Synology repo: development/synology-github-repo.md
|
||||
- Deployment:
|
||||
- Overview: deployment/index.md
|
||||
- Docker: deployment/docker.md
|
||||
- Production: deployment/production.md
|
||||
- Environment Variables: deployment/environment.md
|
||||
|
||||
# Theme configuration
|
||||
theme:
|
||||
@@ -158,4 +252,4 @@ extra:
|
||||
link: https://github.com/yourusername
|
||||
|
||||
# Copyright
|
||||
copyright: Copyright © 2024 Letzshop Team
|
||||
copyright: Copyright © 2024-2025 Wizamart Team
|
||||
Reference in New Issue
Block a user