What problem does it solve?
Generates a comprehensive docs/ directory that explains WHAT a codebase is, HOW it works, and WHY decisions were made, enabling AI agents and humans to understand and contribute without starting from scratch. It detects monorepos, supports re-running to refresh outdated content, and runs automatically without user prompts.
Core Features & Use Cases
- Scans any codebase (single repo or monorepo) to produce structured markdown docs.
- Generates: overview.md, architecture.md, getting-started.md, development.md, adr/ (index and individual ADRs), glossary.md.
- Detects stale content and re-runs to update changed areas; centralizes existing ADRs into docs/adr/.
- Works offline and in CI, with templates and references to support customization.
Quick Start
Run the included script from the project root to generate the full docs/ set.