# Documentation Index

Welcome to MetaBuilder documentation. This guide helps you find what you need.

## Start Here

- **[README.md](README.md)** - Project overview and quick start
- **[PRD.md](PRD.md)** - Product requirements and feature specifications
- **[SECURITY.md](SECURITY.md)** - Security policies and best practices

## Documentation by Topic

### [Guides](guides/)
Quick references and setup instructions for developers.

- **[IMPLEMENTATION_ROADMAP.md](guides/IMPLEMENTATION_ROADMAP.md)** - Feature development timeline
- **[ATOMIC_QUICKSTART.md](guides/ATOMIC_QUICKSTART.md)** - Get started with atomic design patterns
- **[ACT_QUICK_REFERENCE.md](guides/ACT_QUICK_REFERENCE.md)** - GitHub Actions testing quick ref
- **[SASS_QUICKSTART.md](guides/SASS_QUICKSTART.md)** - SASS/SCSS quick start
- **[SASS_QUICK_REFERENCE.md](guides/SASS_QUICK_REFERENCE.md)** - SASS/SCSS styling guide
- **[SASS_DOCUMENTATION_INDEX.md](guides/SASS_DOCUMENTATION_INDEX.md)** - SASS documentation index
- **[SASS_EXAMPLES.md](guides/SASS_EXAMPLES.md)** - SASS code examples
- **[github-actions-local-testing.md](guides/github-actions-local-testing.md)** - Test workflows locally

### [Implementation Guides](implementation/)
Deep-dive documentation on implemented features and architecture.

- **[COMPONENT_MAP.md](implementation/COMPONENT_MAP.md)** - Component structure and organization
- **[ATOMIC_DESIGN.md](implementation/ATOMIC_DESIGN.md)** - Atomic design system
- **[MULTI_TENANT_SYSTEM.md](implementation/MULTI_TENANT_SYSTEM.md)** - Multi-tenancy architecture
- **[PRISMA_IMPLEMENTATION_COMPLETE.md](implementation/PRISMA_IMPLEMENTATION_COMPLETE.md)** - Database layer
- **[DBAL_INTEGRATION.md](implementation/DBAL_INTEGRATION.md)** - Data abstraction layer
- **[SECURE_DATABASE_LAYER.md](implementation/SECURE_DATABASE_LAYER.md)** - Database security
- **[BLOB_STORAGE_IMPLEMENTATION.md](implementation/BLOB_STORAGE_IMPLEMENTATION.md)** - File storage
- **[NEXTJS_MIGRATION.md](implementation/NEXTJS_MIGRATION.md)** - Next.js migration
- **[UNIT_TESTS_IMPLEMENTATION.md](implementation/UNIT_TESTS_IMPLEMENTATION.md)** - Testing strategy

### [Build System](builds/)
C++ build, compilation, and cross-platform setup.

- **[CROSS_PLATFORM_BUILD.md](builds/CROSS_PLATFORM_BUILD.md)** - Cross-platform compilation
- **[CPP_BUILD_QUICK_REF.md](builds/CPP_BUILD_QUICK_REF.md)** - C++ build quick reference
- **[CPP_BUILD_ASSISTANT.md](builds/CPP_BUILD_ASSISTANT.md)** - Build troubleshooting

### [Deployments & CI/CD](deployments/)
Production deployment, containerization, and continuous integration.

- **[NGINX_INTEGRATION.md](deployments/NGINX_INTEGRATION.md)** - Web server configuration
- **[GITHUB_WORKFLOWS_AUDIT.md](deployments/GITHUB_WORKFLOWS_AUDIT.md)** - CI/CD pipeline review
- **[CI_CD_SUMMARY.md](deployments/CI_CD_SUMMARY.md)** - Build & deployment overview

### [Migrations](migrations/)
Data migrations, code refactoring, and relocation guides.

- **[MIGRATION_STATUS.md](migrations/MIGRATION_STATUS.md)** - Migration progress tracking
- **[FILE_RELOCATION_GUIDE.md](migrations/FILE_RELOCATION_GUIDE.md)** - File organization
- **[RELOCATION_SUMMARY.md](migrations/RELOCATION_SUMMARY.md)** - Relocation completion status

### [Troubleshooting](troubleshooting/)
Diagnostics, debugging guides, and common issues.

- **[WORKFLOW_FAILURE_DIAGNOSIS.md](troubleshooting/WORKFLOW_FAILURE_DIAGNOSIS.md)** - CI/CD debugging
- **[CORS-BYPASS-EXPLANATION.md](troubleshooting/CORS-BYPASS-EXPLANATION.md)** - CORS issues
- **[TEST_COVERAGE_SUMMARY.md](troubleshooting/TEST_COVERAGE_SUMMARY.md)** - Test coverage info
- **[PACKAGE_TESTS.md](troubleshooting/PACKAGE_TESTS.md)** - Package testing guide

### [Archive](archive/)
Completed phases and historical work.

- **[PHASE2_SUMMARY.md](archive/PHASE2_SUMMARY.md)** - Phase 2 completion summary

## Code-to-Documentation Mapping

### [Source Code (src/)](src/)
Documentation for TypeScript/React source code

- **[components/](src/components/)** - React components (atoms, molecules, organisms)
- **[lib/](src/lib/)** - Core library modules (auth, database, lua, packages)
- **[hooks/](src/hooks/)** - React custom hooks
- **[seed-data/](src/seed-data/)** - Database seed data
- **[types/](src/types/)** - TypeScript type definitions
- **[styles/](src/styles/)** - Styling system and Tailwind configuration
- **[tests/](src/tests/)** - Unit and integration tests

### [DBAL (Data Abstraction Layer)](dbal/)
Documentation for C++ and TypeScript database layer

- **[api/](dbal/api/)** - API schemas and versioning
- **[backends/](dbal/backends/)** - Database backend implementations (Prisma, SQLite)
- **[common/](dbal/common/)** - Shared DBAL utilities
- **[cpp/](dbal/cpp/)** - C++ implementation
- **[ts/](dbal/ts/)** - TypeScript implementation
- **[tools/](dbal/tools/)** - Development tools
- **[scripts/](dbal/scripts/)** - Automation scripts

### [Packages](packages/)
Documentation for feature packages

- **[admin_dialog.md](packages/admin_dialog.md)** - Admin dialog components
- **[dashboard.md](packages/dashboard.md)** - Dashboard components
- **[data_table.md](packages/data_table.md)** - Data table component
- **[form_builder.md](packages/form_builder.md)** - Form builder system
- **[nav_menu.md](packages/nav_menu.md)** - Navigation menu components
- **[notification_center.md](packages/notification_center.md)** - Notification system
- **[spark-tools.md](packages/spark-tools.md)** - Development tools package

## Additional Topics

### Architecture
Fundamental architecture and design patterns.

- **[architecture/](architecture/)** - Core architecture documents

### Database
Database-specific documentation.

- **[database/](database/)** - Database design and setup

### Development
Development workflow and best practices.

- **[development/](development/)** - Development guides

### Lua Scripting
Lua integration and scripting.

- **[lua/](lua/)** - Lua documentation and examples

### Reference
Quick lookup and API reference.

- **[reference/](reference/)** - Technical references

### Security
Security policies and guidelines.

- **[security/](security/)** - Security documentation

## Navigation Tips

1. **New to MetaBuilder?** Start with [README.md](README.md) and [ATOMIC_QUICKSTART.md](guides/ATOMIC_QUICKSTART.md)
2. **Building a feature?** Check [IMPLEMENTATION_ROADMAP.md](guides/IMPLEMENTATION_ROADMAP.md) and the [implementation/](implementation/) folder
3. **Setting up locally?** See [SASS_QUICK_REFERENCE.md](guides/SASS_QUICK_REFERENCE.md) and [guides/](guides/)
4. **Deploying to production?** Review [NGINX_INTEGRATION.md](deployments/NGINX_INTEGRATION.md) and [deployments/](deployments/)
5. **Debugging issues?** Check [troubleshooting/](troubleshooting/) first
6. **Running CI/CD locally?** See [github-actions-local-testing.md](guides/github-actions-local-testing.md)