mirror of
https://github.com/johndoe6345789/metabuilder.git
synced 2026-04-25 06:14:59 +00:00
JohnDoe6345789
d6e9197ce7
- Created new utility files for password, schema, and page rendering. - Refactored secure-db-layer to separate operations into distinct files. - Added operations for creating, updating, and deleting comments and users. - Implemented access rules for credential management. - Enhanced user and credential verification processes. - Introduced seed data and workflow engine modules. - Updated security context and access checks for various operations.
12 KiB
12 KiB
MetaBuilder Documentation Navigation
A complete guide to finding what you need in the MetaBuilder docs.
🎯 Start Here
- README.md - Project overview
- INDEX.md - Quick navigation hub
- ORGANIZATION.md - How docs are organized
📚 By Category
🚀 Getting Started
Essential reading for new team members:
- getting-started/README.md - Onboarding guide
- getting-started/PRD.md - Product requirements
- guides/getting-started.md - Setup walkthrough
- guides/EXECUTIVE_BRIEF.md - Executive overview
- getting-started/NEW_CONTRIBUTOR_PATH.md - ⭐ Structured 2-3 hr learning path
🏗️ Architecture & Design
Core system architecture:
- architecture/5-level-system.md - Permission hierarchy
- architecture/data-driven-architecture.md - Declarative design
- architecture/packages.md - Package system
- architecture/database.md - Database design
- architecture/generic-page-system.md - Component rendering
- architecture/declarative-components.md - Component architecture
- architecture/css-as-abstract-system.md - CSS as data and GUI mapping
- architecture/deployment.md - Deployment patterns
- architecture/ARCHITECTURE_DIAGRAM.md - Visual architecture
🧪 Testing & Quality
Test strategy, implementation, and metrics:
- testing/TESTING_GUIDELINES.md - Best practices
- testing/UNIT_TESTS_IMPLEMENTATION.md - Unit testing guide
- testing/TESTING_IMPLEMENTATION_SUMMARY.md - Implementation overview
- testing/TESTING_QUICK_REFERENCE.md - Quick reference
- testing/UNIT_TEST_CHECKLIST.md - Checklist
- testing/FUNCTION_TEST_COVERAGE.md - Coverage report
- quality-metrics/README.md - Quality overview
- quality-metrics/QUALITY_METRICS_IMPLEMENTATION.md - Metrics guide
🔄 Refactoring
Code quality and refactoring guides:
- refactoring/REFACTORING_STRATEGY.md - Strategy overview
- refactoring/REFACTORING_QUICK_REFERENCE.md - Quick reference
- refactoring/REFACTORING_ENFORCEMENT_GUIDE.md - Standards enforcement
- refactoring/REFACTORING_CHECKLIST.md - Implementation checklist
- refactoring/REFACTORING_QUICK_START.md - Quick start
📦 Packages & Components
Package system documentation:
- packages/README.md - Package overview
- packages/PACKAGE_SYSTEM_COMPLETION.md - System completion status
- packages/admin_dialog.md - Admin dialog package
- packages/dashboard.md - Dashboard package
- packages/data_table.md - Data table package
- packages/form_builder.md - Form builder package
🛠️ Implementation & Integration
Detailed implementation guides:
- implementation/COMPONENT_MAP.md - Component structure
- implementation/MULTI_TENANT_SYSTEM.md - Multi-tenancy guide
- implementation/PRISMA_IMPLEMENTATION_COMPLETE.md - ORM setup
- implementation/DBAL_INTEGRATION.md - DBAL integration
- implementation/TYPESCRIPT_DBAL_ENHANCEMENTS.md - Type enhancements
- implementation/SECURE_DATABASE_LAYER.md - Database security
- implementation/IMPLEMENTATION_SUMMARY.md - Summary
- implementation/IMPROVEMENT_ROADMAP_INDEX.md - Roadmap
- implementation/COMPONENT_VIOLATION_ANALYSIS.md - Violation analysis
🗄️ Database
Database documentation:
- database/README.md - Overview
- database/PRISMA_SETUP.md - Prisma setup
- database/overview.md - Schema overview
- migrations/README.md - Migration guide
🔒 Security
Security and compliance:
- security/SECURITY.md - Security best practices
- security/SECURE_DATABASE_LAYER.md - Database layer security
🚀 API & Integration
API reference and integration:
- api/README.md - API overview
- api/platform-guide.md - Platform guide
- api/quick-reference.md - Quick reference
- dbal/README.md - DBAL overview
🚢 Deployment & DevOps
Deployment and infrastructure:
- deployments/README.md - Deployment overview
- deployments/CI_CD_SUMMARY.md - CI/CD summary
- deployments/GITHUB_WORKFLOWS_AUDIT.md - Workflows audit
- deployments/NGINX_INTEGRATION.md - Nginx setup
💻 Development Workflows
Development guides and tools:
- development/README.md - Development overview
- development/improvements.md - Improvements guide
- development/typescript-reduction-guide.md - TypeScript reduction
- development/STATE_MANAGEMENT_GUIDE.md - State management
- guides/ACT_CHEAT_SHEET.md - Act cheat sheet
- guides/ACT_QUICK_REFERENCE.md - Act quick reference
- guides/ACT_TESTING.md - Act testing
- guides/ACT_INTEGRATION_ASSESSMENT.md - Act integration
- guides/ACT_OPTIMIZATION_COMPLETE.md - Act optimization
🐛 Stub Detection
Stub detection system:
- stub-detection/README.md - Overview
- stub-detection/STUB_DETECTION_IMPLEMENTATION.md - Implementation
- stub-detection/STUB_DETECTION_QUICK_START.md - Quick start
- stub-detection/STUB_DETECTION_SUMMARY.md - Summary
🐍 Lua Scripting
Lua integration and scripting:
- lua/README.md - Lua overview
- lua/integration.md - Integration guide
- lua/snippets-guide.md - Snippets guide
📋 Reference
Additional references:
- reference/README.md - Reference overview
- reference/documentation-index.md - Detailed index
- reference/code-docs-mapping.md - Code-to-docs mapping
📚 Troubleshooting
Problem solving:
- troubleshooting/README.md - Troubleshooting overview
- troubleshooting/common-issues.md - Common issues
🔧 Build & Deployment
Build and compilation:
- builds/CPP_BUILD_ASSISTANT_SUMMARY.md - C++ build summary
- 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 - Source overview
- src/components/ - Component docs
- src/lib/ - Library docs
- src/types/ - Type definitions
🏁 DBAL (Database Abstraction Layer)
- dbal/README.md - Overview
- dbal/api/README.md - API docs
- dbal/backends/README.md - Backends
- dbal/cpp/README.md - C++ implementation
- dbal/ts/README.md - TypeScript implementation
- dbal/common/README.md - Common code
📖 Additional Guides
- guides/SASS_CONFIGURATION.md - SASS setup
- guides/SASS_DOCUMENTATION_INDEX.md - SASS docs
- guides/SASS_EXAMPLES.md - SASS examples
- guides/SASS_SETUP_COMPLETE.md - SASS complete
- guides/ATOMIC_QUICKSTART.md - Atomic quick start
- guides/IMPLEMENTATION_ROADMAP.md - Roadmap
- guides/PRIORITY_ACTION_PLAN.md - Action plan
- guides/TEAM_CHECKLIST.md - Team checklist
🎯 Quick Links by Task
I want to...
| Task | Link |
|---|---|
| Get started | getting-started/NEW_CONTRIBUTOR_PATH.md |
| Understand architecture | architecture/5-level-system.md |
| Write tests | testing/TESTING_GUIDELINES.md |
| Refactor code | refactoring/REFACTORING_STRATEGY.md |
| Create a package | packages/README.md |
| Integrate with DBAL | implementation/DBAL_INTEGRATION.md |
| Deploy | deployments/README.md |
| Troubleshoot | troubleshooting/README.md |
| Check quality metrics | quality-metrics/README.md |
| Use Act locally | guides/ACT_CHEAT_SHEET.md |
| Learn Lua | lua/snippets-guide.md |
| Setup SASS | 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:
- Choose the appropriate category from above
- Add a link to this navigation file
- Update the relevant README.md in that directory
- Update INDEX.md if it's a major document
For more info, see ORGANIZATION.md.