Codebase Summary
Intents
Document the repository structure and key entry pointsUpdate the codebase summary — we reorganized the src/ directoryMap the codebase so new contributors can get oriented quicklyWhere does everything live in this project?References
Read references/codebase-summary-conventions.md for placement rules and references/codebase-summary-template.md for section structure.
Scope
Codebase summary captures repository structure and navigation — how to find things. Architecture rationale belongs in system-design; feature behavior in specs.
Input
Synthesize from: direct codebase exploration (directories, entry points, modules), existing docs (README, package.json, etc.), conversation context, or direct prompts.
Workflow: Create
- Explore the repository to understand layout, entry points, and module boundaries.
- Map into template sections from
references/codebase-summary-template.md. Align to local convention if one exists. - Place at the repository's existing path, or fallback:
docs/codebase-summary.md. - Include local dev commands if discoverable.
Workflow: Iterate
- Read the existing summary in full.
- Explore current codebase to identify what changed.
- Update affected sections in place. Preserve unchanged content.
- Update
Last updateddate.
Output
- Create: complete codebase summary at
docs/codebase-summary.md - Iterate: targeted updates to affected sections only
- Layout matches actual directory structure
- Entry points and dev commands are current and runnable
- No architecture rationale (belongs in system-design)