explaining-code
Produce accurate, consistent, easy-to-read HTML documentation that explains a codebase — one feature, one subsystem, or a whole repository — by reading the real source and tracing every claim to a file:line. Use this whenever the user asks to "explain how X works", "document this repo/feature", "walk me through the codebase", "create a diagram of this flow", "how does this module/pipeline/endpoint work", or wants a visual, structured explanation of code they can keep and share. Prefer this skill over an off-the-cuff prose answer whenever the explanation would benefit from structure, diagrams, or a document the user keeps — even if they do not say the word "documentation".
Pinned to revision 3bb033b50d25, so it is the text this page describes rather than whatever the author pushed since.
Files
- skills/explaining-code/SKILL.md
- skills/explaining-code/agents/openai.yaml
- skills/explaining-code/assets/index-template.html
- skills/explaining-code/assets/page-template.html
- skills/explaining-code/assets/style.css
- skills/explaining-code/references/diagram-grammar.md
- skills/explaining-code/references/gates.md
- skills/explaining-code/references/term-ledger.md
- skills/explaining-code/references/writing-rules.md
Every link opens the file at its source, pinned to the revision this page describes.