Codebase Summarizer

What it does

The Codebase Summarizer analyzes a code repository to generate comprehensive architecture documentation. It recursively scans the folder structure, identifies key patterns and frameworks used, maps entry points like main files and APIs, traces data flow between layers (controllers, services, models), documents individual modules, creates "how-to" guides for common tasks, and generates visual diagrams using Mermaid syntax. The output is structured as an ARCHITECTURE.md file containing a system overview, tech stack details, high-level architecture diagram, project structure breakdown, key component descriptions, data flow sequences, request lifecycles, and examples of common patterns.

When to use it

• When onboarding new developers to a complex codebase.
• To quickly understand the overall architecture of an unfamiliar project.
• For generating documentation as part of a continuous integration/continuous delivery (CI/CD) pipeline.
• To create "how-to" guides for common development tasks within the project.
• When needing to communicate the codebase structure and key components to stakeholders.

Key capabilities

• Recursive Folder Scanning: Analyzes directory structures to understand organization.
• Pattern Detection: Identifies frameworks, architecture styles, and key directories.
• Entry Point Mapping: Locates main files, routes, APIs, and CLI commands.
• Data Flow Tracing: Visualizes request flow through application layers.
• Module Documentation: Explains the purpose and responsibilities of each directory.
• Navigation Guide Creation: Generates "how-to" guides for common tasks.
• Mermaid Diagram Generation: Creates visual architecture diagrams.
• Documentation Structure: Produces a standardized ARCHITECTURE.md file with sections for overview, tech stack, architecture diagram, project structure, key components, data flow, and request lifecycle.

Example prompts

• "Summarize the codebase in this repository."
• "Generate an ARCHITECTURE.md document for this project."
• "Show me a diagram of the application's high-level architecture."

Tips & gotchas

• The skill generates documentation based on code structure and patterns; it may require manual review and adjustments to ensure accuracy and completeness.
• The generated Mermaid diagrams are dependent on correct syntax within the codebase.