# MetaBuilder Documentation Navigation

A complete guide to finding what you need in the MetaBuilder docs.

## 🎯 Start Here

- **[README.md](./README.md)** - Project overview
- **[INDEX.md](./INDEX.md)** - Quick navigation hub
- **[ORGANIZATION.md](./ORGANIZATION.md)** - How docs are organized

---

## 📚 By Category

### 🚀 Getting Started
Essential reading for new team members:
- [getting-started/README.md](./getting-started/README.md) - Onboarding guide
- [getting-started/PRD.md](./getting-started/PRD.md) - Product requirements
- [guides/getting-started.md](./guides/getting-started.md) - Setup walkthrough
- [guides/EXECUTIVE_BRIEF.md](./guides/EXECUTIVE_BRIEF.md) - Executive overview
- [getting-started/NEW_CONTRIBUTOR_PATH.md](./getting-started/NEW_CONTRIBUTOR_PATH.md) - ⭐ **Structured 2-3 hr learning path**

### 🏗️ Architecture & Design
Core system architecture:
- [architecture/5-level-system.md](./architecture/5-level-system.md) - Permission hierarchy
- [architecture/data-driven-architecture.md](./architecture/data-driven-architecture.md) - Declarative design
- [architecture/packages.md](./architecture/packages.md) - Package system
- [architecture/database.md](./architecture/database.md) - Database design
- [architecture/generic-page-system.md](./architecture/generic-page-system.md) - Component rendering
- [architecture/declarative-components.md](./architecture/declarative-components.md) - Component architecture
- [architecture/css-as-abstract-system.md](./architecture/css-as-abstract-system.md) - CSS as data and GUI mapping
- [architecture/deployment.md](./architecture/deployment.md) - Deployment patterns
- [architecture/ARCHITECTURE_DIAGRAM.md](./architecture/ARCHITECTURE_DIAGRAM.md) - Visual architecture

### 🧪 Testing & Quality
Test strategy, implementation, and metrics:
- [testing/TESTING_GUIDELINES.md](./testing/TESTING_GUIDELINES.md) - Best practices
- [testing/UNIT_TESTS_IMPLEMENTATION.md](./testing/UNIT_TESTS_IMPLEMENTATION.md) - Unit testing guide
- [testing/TESTING_IMPLEMENTATION_SUMMARY.md](./testing/TESTING_IMPLEMENTATION_SUMMARY.md) - Implementation overview
- [testing/TESTING_QUICK_REFERENCE.md](./testing/TESTING_QUICK_REFERENCE.md) - Quick reference
- [testing/UNIT_TEST_CHECKLIST.md](./testing/UNIT_TEST_CHECKLIST.md) - Checklist
- [testing/FUNCTION_TEST_COVERAGE.md](./testing/FUNCTION_TEST_COVERAGE.md) - Coverage report
- [quality-metrics/README.md](./quality-metrics/README.md) - Quality overview
- [quality-metrics/QUALITY_METRICS_IMPLEMENTATION.md](./quality-metrics/QUALITY_METRICS_IMPLEMENTATION.md) - Metrics guide

### 🔄 Refactoring
Code quality and refactoring guides:
- [refactoring/REFACTORING_STRATEGY.md](./refactoring/REFACTORING_STRATEGY.md) - Strategy overview
- [refactoring/REFACTORING_QUICK_REFERENCE.md](./refactoring/REFACTORING_QUICK_REFERENCE.md) - Quick reference
- [refactoring/REFACTORING_ENFORCEMENT_GUIDE.md](./refactoring/REFACTORING_ENFORCEMENT_GUIDE.md) - Standards enforcement
- [refactoring/REFACTORING_CHECKLIST.md](./refactoring/REFACTORING_CHECKLIST.md) - Implementation checklist
- [refactoring/REFACTORING_QUICK_START.md](./refactoring/REFACTORING_QUICK_START.md) - Quick start

### 📦 Packages & Components
Package system documentation:
- [packages/README.md](./packages/README.md) - Package overview
- [packages/PACKAGE_SYSTEM_COMPLETION.md](./packages/PACKAGE_SYSTEM_COMPLETION.md) - System completion status
- [packages/admin_dialog.md](./packages/admin_dialog.md) - Admin dialog package
- [packages/dashboard.md](./packages/dashboard.md) - Dashboard package
- [packages/data_table.md](./packages/data_table.md) - Data table package
- [packages/form_builder.md](./packages/form_builder.md) - Form builder package

### 🛠️ Implementation & Integration
Detailed implementation guides:
- [implementation/COMPONENT_MAP.md](./implementation/COMPONENT_MAP.md) - Component structure
- [implementation/MULTI_TENANT_SYSTEM.md](./implementation/MULTI_TENANT_SYSTEM.md) - Multi-tenancy guide
- [implementation/PRISMA_IMPLEMENTATION_COMPLETE.md](./implementation/PRISMA_IMPLEMENTATION_COMPLETE.md) - ORM setup
- [implementation/DBAL_INTEGRATION.md](./implementation/DBAL_INTEGRATION.md) - DBAL integration
- [implementation/TYPESCRIPT_DBAL_ENHANCEMENTS.md](./implementation/TYPESCRIPT_DBAL_ENHANCEMENTS.md) - Type enhancements
- [implementation/SECURE_DATABASE_LAYER.md](./implementation/SECURE_DATABASE_LAYER.md) - Database security
- [implementation/IMPLEMENTATION_SUMMARY.md](./implementation/IMPLEMENTATION_SUMMARY.md) - Summary
- [implementation/IMPROVEMENT_ROADMAP_INDEX.md](./implementation/IMPROVEMENT_ROADMAP_INDEX.md) - Roadmap
- [implementation/COMPONENT_VIOLATION_ANALYSIS.md](./implementation/COMPONENT_VIOLATION_ANALYSIS.md) - Violation analysis

### 🗄️ Database
Database documentation:
- [database/README.md](./database/README.md) - Overview
- [database/PRISMA_SETUP.md](./database/PRISMA_SETUP.md) - Prisma setup
- [database/overview.md](./database/overview.md) - Schema overview
- [migrations/README.md](./migrations/README.md) - Migration guide

### 🔒 Security
Security and compliance:
- [security/SECURITY.md](./security/SECURITY.md) - Security best practices
- [security/SECURE_DATABASE_LAYER.md](./security/SECURE_DATABASE_LAYER.md) - Database layer security

### 🚀 API & Integration
API reference and integration:
- [api/README.md](./api/README.md) - API overview
- [api/platform-guide.md](./api/platform-guide.md) - Platform guide
- [api/quick-reference.md](./api/quick-reference.md) - Quick reference
- [dbal/README.md](./dbal/README.md) - DBAL overview

### 🚢 Deployment & DevOps
Deployment and infrastructure:
- [deployments/README.md](./deployments/README.md) - Deployment overview
- [deployments/CI_CD_SUMMARY.md](./deployments/CI_CD_SUMMARY.md) - CI/CD summary
- [deployments/GITHUB_WORKFLOWS_AUDIT.md](./deployments/GITHUB_WORKFLOWS_AUDIT.md) - Workflows audit
- [deployments/NGINX_INTEGRATION.md](./deployments/NGINX_INTEGRATION.md) - Nginx setup

### 💻 Development Workflows
Development guides and tools:
- [development/README.md](./development/README.md) - Development overview
- [development/improvements.md](./development/improvements.md) - Improvements guide
- [development/typescript-reduction-guide.md](./development/typescript-reduction-guide.md) - TypeScript reduction
- [development/STATE_MANAGEMENT_GUIDE.md](./development/STATE_MANAGEMENT_GUIDE.md) - State management
- [guides/ACT_CHEAT_SHEET.md](./guides/ACT_CHEAT_SHEET.md) - Act cheat sheet
- [guides/ACT_QUICK_REFERENCE.md](./guides/ACT_QUICK_REFERENCE.md) - Act quick reference
- [guides/ACT_TESTING.md](./guides/ACT_TESTING.md) - Act testing
- [guides/ACT_INTEGRATION_ASSESSMENT.md](./guides/ACT_INTEGRATION_ASSESSMENT.md) - Act integration
- [guides/ACT_OPTIMIZATION_COMPLETE.md](./guides/ACT_OPTIMIZATION_COMPLETE.md) - Act optimization

### 🐛 Stub Detection
Stub detection system:
- [stub-detection/README.md](./stub-detection/README.md) - Overview
- [stub-detection/STUB_DETECTION_IMPLEMENTATION.md](./stub-detection/STUB_DETECTION_IMPLEMENTATION.md) - Implementation
- [stub-detection/STUB_DETECTION_QUICK_START.md](./stub-detection/STUB_DETECTION_QUICK_START.md) - Quick start
- [stub-detection/STUB_DETECTION_SUMMARY.md](./stub-detection/STUB_DETECTION_SUMMARY.md) - Summary

### 🐍 Lua Scripting
Lua integration and scripting:
- [lua/README.md](./lua/README.md) - Lua overview
- [lua/integration.md](./lua/integration.md) - Integration guide
- [lua/snippets-guide.md](./lua/snippets-guide.md) - Snippets guide

### 📋 Reference
Additional references:
- [reference/README.md](./reference/README.md) - Reference overview
- [reference/documentation-index.md](./reference/documentation-index.md) - Detailed index
- [reference/code-docs-mapping.md](./reference/code-docs-mapping.md) - Code-to-docs mapping

### 📚 Troubleshooting
Problem solving:
- [troubleshooting/README.md](./troubleshooting/README.md) - Troubleshooting overview
- [troubleshooting/common-issues.md](./troubleshooting/common-issues.md) - Common issues

### 🔧 Build & Deployment
Build and compilation:
- [builds/CPP_BUILD_ASSISTANT_SUMMARY.md](./builds/CPP_BUILD_ASSISTANT_SUMMARY.md) - C++ build summary
- [builds/CROSS_PLATFORM_BUILD.md](./builds/CROSS_PLATFORM_BUILD.md) - Cross-platform build

### 📁 Source Code Documentation
Source code structure:
TODO: docs/src/ is missing; add the folder or update/remove the src links below.
- [src/README.md](./src/README.md) - Source overview
- [src/components/](./src/components/) - Component docs
- [src/lib/](./src/lib/) - Library docs
- [src/types/](./src/types/) - Type definitions

### 🏁 DBAL (Database Abstraction Layer)
- [dbal/README.md](./dbal/README.md) - Overview
- [dbal/api/README.md](./dbal/api/README.md) - API docs
- [dbal/backends/README.md](./dbal/backends/README.md) - Backends
- [dbal/cpp/README.md](./dbal/cpp/README.md) - C++ implementation
- [dbal/ts/README.md](./dbal/ts/README.md) - TypeScript implementation
- [dbal/common/README.md](./dbal/common/README.md) - Common code

### 📖 Additional Guides
- [guides/SASS_CONFIGURATION.md](./guides/SASS_CONFIGURATION.md) - SASS setup
- [guides/SASS_DOCUMENTATION_INDEX.md](./guides/SASS_DOCUMENTATION_INDEX.md) - SASS docs
- [guides/SASS_EXAMPLES.md](./guides/SASS_EXAMPLES.md) - SASS examples
- [guides/SASS_SETUP_COMPLETE.md](./guides/SASS_SETUP_COMPLETE.md) - SASS complete
- [guides/ATOMIC_QUICKSTART.md](./guides/ATOMIC_QUICKSTART.md) - Atomic quick start
- [guides/IMPLEMENTATION_ROADMAP.md](./guides/IMPLEMENTATION_ROADMAP.md) - Roadmap
- [guides/PRIORITY_ACTION_PLAN.md](./guides/PRIORITY_ACTION_PLAN.md) - Action plan
- [guides/TEAM_CHECKLIST.md](./guides/TEAM_CHECKLIST.md) - Team checklist

---

## 🎯 Quick Links by Task

### I want to...

| Task | Link |
|------|------|
| **Get started** | [getting-started/NEW_CONTRIBUTOR_PATH.md](./getting-started/NEW_CONTRIBUTOR_PATH.md) |
| **Understand architecture** | [architecture/5-level-system.md](./architecture/5-level-system.md) |
| **Write tests** | [testing/TESTING_GUIDELINES.md](./testing/TESTING_GUIDELINES.md) |
| **Refactor code** | [refactoring/REFACTORING_STRATEGY.md](./refactoring/REFACTORING_STRATEGY.md) |
| **Create a package** | [packages/README.md](./packages/README.md) |
| **Integrate with DBAL** | [implementation/DBAL_INTEGRATION.md](./implementation/DBAL_INTEGRATION.md) |
| **Deploy** | [deployments/README.md](./deployments/README.md) |
| **Troubleshoot** | [troubleshooting/README.md](./troubleshooting/README.md) |
| **Check quality metrics** | [quality-metrics/README.md](./quality-metrics/README.md) |
| **Use Act locally** | [guides/ACT_CHEAT_SHEET.md](./guides/ACT_CHEAT_SHEET.md) |
| **Learn Lua** | [lua/snippets-guide.md](./lua/snippets-guide.md) |
| **Setup SASS** | [guides/SASS_CONFIGURATION.md](./guides/SASS_CONFIGURATION.md) |

---

## 📊 Documentation Stats

- **Total Documentation Files**: 168+ markdown files
- **Main Categories**: 23 directories
- **Quick References**: 10+ cheat sheets
- **Implementation Guides**: 15+ detailed guides
- **Architecture Docs**: 9+ architecture files

---

## 🔍 Search Tips

Use `Ctrl+P` (or `Cmd+P` on Mac) in VS Code to quickly find files:
- Type `TESTING_` to find all testing-related docs
- Type `DBAL_` to find database layer docs
- Type `REFACTORING_` to find refactoring guides
- Type `architecture/` to browse architecture files
- Type `guides/ACT_` to find Act testing guides

---

## 📝 Contributing

When adding new documentation:
1. Choose the appropriate category from above
2. Add a link to this navigation file
3. Update the relevant README.md in that directory
4. Update [INDEX.md](./INDEX.md) if it's a major document

For more info, see [ORGANIZATION.md](./ORGANIZATION.md).
