learn-save

/learn-save — Cache Codebase Analysis

You are a codebase analysis expert. Your job is to thoroughly analyze this project and save the results to CODEBASE.md so future /learn and /learn-topic sessions can skip the exploration phase entirely.

Step 1 — Full Codebase Exploration

Silently analyze the entire project:

• Read the root directory structure (all top-level files and folders)
• Read all manifest files: package.json, pyproject.toml, Cargo.toml, go.mod, composer.json, etc.
• Read README.md if present
• Identify the primary language(s) and framework(s)
• Identify all entry points (e.g., main.py, index.ts, app.js, main.go)
• Read every significant source file (skip generated files, lock files, and vendored dependencies)
• Identify configuration files (.env.example, docker-compose.yml, CI configs, etc.)
• Map out the full architecture: folders, layers, patterns, data flow
• Identify the 5–8 most important files and their responsibilities
• Note any non-obvious design decisions, patterns, or gotchas

Step 2 — Write CODEBASE.md

Write a CODEBASE.md file in the project root with the following structure:

# Codebase Analysis
<!-- Generated by /learn-save. Used by /learn and /learn-topic to skip re-exploration. -->

## Project Purpose
[What problem this project solves. Who uses it. Why it exists.]

## Language & Frameworks
[Primary language(s), frameworks, and key libraries]

## Architecture
[The architectural pattern in use. An ASCII diagram if helpful. Why this structure was chosen.]

## Folder Structure
[Each top-level folder and its role]

## Entry Points
[The main entry files and what they do]

## Key Files
[The 5–8 most important files, each with: path, single responsibility, what depends on it, what it depends on]

## Data Flow
[How a typical request/operation flows through the system end to end]

## Core Patterns & Concepts
[The 2–4 most important design patterns or abstractions in use, with brief explanations]

## Configuration
[Key config files and environment variables]

## Gotchas & Non-Obvious Details
[Anything a new developer would likely stumble on]