mirror of
https://github.com/johndoe6345789/metabuilder.git
synced 2026-04-25 14:25:02 +00:00
johndoe6345789
b3e17e7dd4
- Created a new troubleshooting guide in README.md for common issues and testing problems. - Updated package.json to include new act commands for linting, type checking, building, and diagnosing workflows. - Added a pre-commit hook script to validate workflows before commits. - Enhanced run-act.sh script with logging, Docker checks, and improved output formatting. - Improved test-workflows.sh with an interactive menu and performance tracking. - Introduced setup-act.sh for quick setup and testing of act integration.
2.2 KiB
2.2 KiB
Documentation Organization
MetaBuilder docs organized by purpose for easy navigation.
Structure
docs/
├── README.md # Overview & quick links
├── INDEX.md # Full navigation hub
├── ORGANIZATION.md # This file
│
├── 🎯 Core Concepts
│ ├── architecture/ # System design, 5-level permissions, packages
│ ├── api/ # API reference & integration
│ ├── database/ # Prisma schema & design
│ └── dbal/ # Database abstraction layer
│
├── 🛠️ Development
│ ├── getting-started/ # Setup & quickstart
│ ├── development/ # Dev workflows & tools
│ ├── packages/ # Building packages
│ └── lua/ # Lua scripting
│
├── ✅ Quality
│ ├── testing/ # Testing guidelines
│ ├── quality-metrics/ # Code quality
│ ├── refactoring/ # Refactoring patterns
│ └── stub-detection/ # Finding unimplemented functions
│
├── 🚀 Infrastructure
│ ├── deployments/ # CI/CD & Docker
│ └── migrations/ # Database migrations
│
├── 📖 Reference
│ ├── security/ # Auth & permissions
│ ├── troubleshooting/ # Common issues
│ ├── reference/ # Diagrams & resources
│ └── guides/ # How-to guides & tutorials
│ └── implementation/ # Feature implementations
│
└── 🗃️ archive/ # Legacy & historical
Usage
- New to MetaBuilder? → Start with README
- Need specific info? → Check INDEX
- Searching for something? → Use the structure above
Guidelines
Adding docs
- Place in most relevant folder
- Use kebab-case filenames
- Update folder's README.md
- Link from INDEX.md if new major section
Principles
- One folder per topic area
- Each folder has README.md
- No duplicate content across folders
- Archive old/historical docs in
archive/