mirror of
https://github.com/johndoe6345789/metabuilder.git
synced 2026-04-24 13:54:57 +00:00
docs: 1 files
This commit is contained in:
23
README.md
23
README.md
@@ -1145,29 +1145,6 @@ DEBUG=metabuilder:* npm run dev
|
||||
|
||||
---
|
||||
|
||||
## Documentation Resources
|
||||
|
||||
- [docs/navigation/README.md](./docs/navigation/README.md) is the master index for architecture, deployment, testing, and contribution guidance.
|
||||
- [docs/guides/getting-started.md](./docs/guides/getting-started.md) walks through initial setup, the sanity checklist, and environment tips.
|
||||
- [docs/architecture/packages.md](./docs/architecture/packages.md) and [docs/architecture/database.md](./docs/architecture/database.md) cover package metadata, seed expectations, and tenant-safe Prisma patterns.
|
||||
- [docs/security/README.md](./docs/security/README.md) plus [docs/security/SECURITY.md](./docs/security/SECURITY.md) summarize sandboxed Lua rules, credential handling, and scanning policies.
|
||||
- [docs/guides/ACT_CHEAT_SHEET.md](./docs/guides/ACT_CHEAT_SHEET.md) with [docs/guides/ACT_TESTING.md](./docs/guides/ACT_TESTING.md) explain how to mirror GitHub Actions workflows locally via Act.
|
||||
|
||||
## Documentation Quality
|
||||
|
||||
- Run `./scripts/doc-quality-checker.sh` whenever you touch docs to keep coverage metrics in sync.
|
||||
- The documentation hub cites 60%+ README coverage, 100% JSDoc coverage, 80%+ type annotations, and 100% security documentation targets.
|
||||
|
||||
## Quick Links
|
||||
|
||||
- Permission model: [docs/architecture/security-docs/5-level-system.md](./docs/architecture/security-docs/5-level-system.md)
|
||||
- Database schema: [prisma/schema.prisma](./prisma/schema.prisma)
|
||||
- API conventions: [docs/guides/api-development.md](./docs/guides/api-development.md)
|
||||
- Security guidelines: [docs/security/SECURITY.md](./docs/security/SECURITY.md)
|
||||
- Package system: [docs/architecture/packages.md](./docs/architecture/packages.md)
|
||||
- DBAL documentation: [dbal/README.md](./dbal/README.md)
|
||||
- Tools documentation: [tools/README.md](./tools/README.md)
|
||||
|
||||
## License
|
||||
|
||||
MIT License - See LICENSE file
|
||||
|
||||
Reference in New Issue
Block a user