- Introduction
- Pitch
- Hogwarts
- Live Demo
- MVP
- Roadmap
- Launch Sprint
- PRD
- Get Started
- Localhost
- Architecture
- Structure
- Pattern
- Page
- Layout
- Content
- Types
- Config
- Actions
- Queries
- Authorization
- Validation
- Form
- Table
- Detail
- Card
- Util
- Hooks
- List Params
- Views
- README.md
- ISSUE.md
- Technology Stack
- Database
- File
- CDN Assets
- Entry Points
- Dashboard
- Authentication
- Credentials
- OAuth
- Flow Diagrams
- Multi-Tenancy
- Offline
- Onboarding
- Onboarding Videos
- Add Values
- Admission
- Application
- Attendance
- Compliance
- Profile
- Exams
- Exam Wizard
- Timetable
- Classrooms
- Notifications
- Conference
- LMS (Lumos)
Finance
- Finance
- Fee Management
- Invoice
- Wallet
- Salary
- Payroll
- Timesheet
- Expenses
- Budget
- Receipt
- Accounts
- Banking
- Reports
- Dashboard
- Permissions
- Messages
- Integration Flow
- Provision
- AI Document Processing
- Document Intelligence
- Internationalization
- Translation
- Translation Guide
- Icons
- Docs Factory
- Inspiration
- Listings
- Teachers
- Students
- Catalog
- Library
- Contributing
- Code of conduct
- GitHub Workflow
- Database Seeds
- Database Safety
- Test Accounts
- Playwright
- Prettier
- Block Rebound
Sales & GTM
README.md lives in every feature directory at src/components/<feature>/README.md. It is an index, not documentation — tables only, ~40 lines max, points to files instead of duplicating them.
Rules
| # | Rule |
|---|---|
| 1 | Tables, not prose — zero paragraphs except the one-line purpose |
| 2 | Max 40 lines — split or delete content beyond that |
| 3 | Document only what code can't tell you — decisions, context, gotchas |
| 4 | Auto-update on change — status, files table, decisions |
| 5 | Lives in src/components/<feature>/, not in app/ |
Canonical template
# <Feature>
> One-line purpose.
## Quick Reference
| Key | Value |
| --------- | --------------------------- |
| URL | `/${lang}/<feature>` |
| Directory | `src/components/<feature>/` |
| Status | Draft / Active / Stable |
| Models | `Model1`, `Model2` |
| schoolId | Yes |
## Files
| File | Purpose |
| --------------- | -------------------------------------- |
| `content.tsx` | Server component, data fetching |
| `actions.ts` | Server actions: create, update, delete |
| `form.tsx` | Create/edit form with Zod validation |
| `columns.tsx` | Table column definitions |
| `types.ts` | Domain types and form interfaces |
| `validation.ts` | Zod schemas |
## Decisions
| Decision | Rationale |
| --------------------------- | --------------------------------- |
| Server-side filtering | Dataset too large for client-side |
| Single form for create/edit | Reduces duplication, same schema |
## Dependencies
| Type | Name |
| -------- | ---------------------------------- |
| Internal | `school-dashboard/context`, `auth` |
| External | `@tanstack/react-table`, `zod` |
## Entry Point
- **Read first**: `content.tsx` → `actions.ts` → `types.ts`
- **Test**: `pnpm vitest src/components/<feature>/`
- **URL**: `demo.localhost:3000/en/<feature>`Section budget
| Section | Content | Max rows |
|---|---|---|
| Quick Reference | URL, directory, status, models, schoolId | 5 |
| Files | File → purpose (existing files only) | 10 |
| Decisions | Decision → rationale (MADR-lite) | 5 |
| Dependencies | Internal + external deps | 6 |
| Entry Point | Read first, test command, URL | 3 lines |
Status values
| Status | Meaning |
|---|---|
| Draft | In development, not yet functional |
| Active | Working, may have known issues |
| Stable | Production-ready, well-tested |
Anti-patterns
- Prose paragraphs describing what the feature does — use the one-liner.
- Listing every Prisma field — that's what the schema is for.
- Copy-pasting code examples — code in README goes stale instantly.
- README exceeding 40 lines — duplicating code; split to docs site.
- TODOs in README — they belong in
ISSUE.md.
What belongs where
| Content | In | Not in |
|---|---|---|
| Feature purpose | README.md | Code comments |
| Architecture decisions | README.md | ISSUE.md |
| Known bugs | ISSUE.md | README.md |
| Tech debt | ISSUE.md | README.md |
| Field descriptions | types.ts | README.md |
| API documentation | Docs site | README.md |
| Code examples | Source files | README.md |