metabuilder/docs/INDEX.md

Documentation Index

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

Start Here

• README.md - Project overview and quick start
• PRD.md - Product requirements and feature specifications
• SECURITY.md - Security policies and best practices

Documentation by Topic

Guides

Quick references and setup instructions for developers.

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

Implementation Guides

Deep-dive documentation on implemented features and architecture.

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

Build System

C++ build, compilation, and cross-platform setup.

• CROSS_PLATFORM_BUILD.md - Cross-platform compilation
• CPP_BUILD_QUICK_REF.md - C++ build quick reference
• CPP_BUILD_ASSISTANT.md - Build troubleshooting

Deployments & CI/CD

Production deployment, containerization, and continuous integration.

• NGINX_INTEGRATION.md - Web server configuration
• GITHUB_WORKFLOWS_AUDIT.md - CI/CD pipeline review
• CI_CD_SUMMARY.md - Build & deployment overview

Migrations

Data migrations, code refactoring, and relocation guides.

• MIGRATION_STATUS.md - Migration progress tracking
• FILE_RELOCATION_GUIDE.md - File organization
• RELOCATION_SUMMARY.md - Relocation completion status

Troubleshooting

Diagnostics, debugging guides, and common issues.

• WORKFLOW_FAILURE_DIAGNOSIS.md - CI/CD debugging
• CORS-BYPASS-EXPLANATION.md - CORS issues
• TEST_COVERAGE_SUMMARY.md - Test coverage info
• PACKAGE_TESTS.md - Package testing guide

Archive

Completed phases and historical work.

• PHASE2_SUMMARY.md - Phase 2 completion summary

Code-to-Documentation Mapping

Source Code (src/)

Documentation for TypeScript/React source code

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

DBAL (Data Abstraction Layer)

Documentation for C++ and TypeScript database layer

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

Packages

Documentation for feature packages

• admin_dialog.md - Admin dialog components
• dashboard.md - Dashboard components
• data_table.md - Data table component
• form_builder.md - Form builder system
• nav_menu.md - Navigation menu components
• notification_center.md - Notification system
• spark-tools.md - Development tools package

Additional Topics

Architecture

Fundamental architecture and design patterns.

• architecture/ - Core architecture documents

Database

Database-specific documentation.

• database/ - Database design and setup

Development

Development workflow and best practices.

• development/ - Development guides

Lua Scripting

Lua integration and scripting.

• lua/ - Lua documentation and examples

Reference

Quick lookup and API reference.

• reference/ - Technical references

Security

Security policies and guidelines.

• security/ - Security documentation

Navigation Tips

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