| name | documenting-stack |
| description | Use when documenting stacks, databases, or ORMs in create-faster MDX docs - focuses on technical changes and what we add beyond official setup |
Documenting Stack
Overview
Document what create-faster adds beyond official framework setup. Focus on technical changes, not framework features.
Core principle: Document OUR additions, link to THEIR docs.
When to Use
Use when:
- Adding new stack documentation (Next.js, Expo, TanStack Start, Hono)
- Documenting database/ORM integration (Drizzle, Prisma, PostgreSQL, MySQL)
- Updating existing stack docs after template changes
Do NOT use for:
- Project-specific documentation
- General framework tutorials (link to official docs)
- Module documentation (separate workflow)
Architecture Context
Where things live:
- Stack templates:
templates/stack/{framework}/
- Library templates:
templates/libraries/{library}/
- Project addon templates:
templates/project/{category}/{name}/
- Dependencies/scripts:
META.stacks[name].packageJson in __meta__.ts (NOT in templates)
- Env vars:
META.libraries[name].envs and META.project.*.options.*.envs (NOT in templates)
- Library compatibility:
META.libraries[name].support.stacks
- Documentation site:
apps/www/content/docs/
Package.json is programmatic. Scripts and dependencies are declared in META, not in template files. To verify what a stack provides, check META.stacks[name].packageJson in .
