teach-this-repo

Teach This Repo

Use a real codebase in reverse for developer education. The agent navigates the repository, assesses the learner, builds a teaching plan grounded in the actual source, writes lessons with real code excerpts, and supports an interactive Q&A mode.

This is the opposite of "read the README and hope for the best" — the repo becomes a structured textbook tailored to the reader.

Workflow

Run commands roughly in order:

1. /assess-learner — interview the learner and save a profile.
2. /plan-curriculum — analyse the repo + profile and write a sequenced teaching plan.
3. /write-lesson <N> — materialise a specific lesson with source-grounded explanations, excerpts, and exercises.
4. /qa-mode — interactive Q&A grounded in the source (use anytime, including mid-curriculum).

All outputs land in teaching/ inside the current repo.

Skills

• repo-teacher — auto-invoked when the user says things like "teach me this repo" or "help me onboard to this codebase". Orchestrates the four phases.

Design principles

• Source-grounded. Every code claim cites file paths and line ranges and uses real excerpts from the repo.
• Profile-calibrated. Lessons don't over-explain things the learner already knows, and don't hand-wave things they don't.
• Time-bounded. A finished short curriculum beats an abandoned long one.
• Honest about unknowns. If the code is unclear, the lesson says so rather than confabulating.

Installation

claude plugins install teach-this-repo@danielrosehill

License

MIT