Skip to content

oxfern/explain-diff-typeset

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 

Repository files navigation

explain-typeset skills

npx skills add oxfern/explain-diff-typeset

Two agent skills that turn code understanding into rich, self-contained HTML explainers — background, intuition, walkthrough, and an interactive quiz — styled after shadcn/ui Typeset.

Skill Use for
explain-diff-typeset A specific change: diff, branch, commit range, or PR
explain-code-question General questions: "how does auth work here?", "why is this structured this way?"

Based on Geoffrey Litt's explain-diff recipe, incorporating the quiz-quality and boilerplate-factoring feedback from its comment threads:

  • Quiz options are shuffled deterministically by the renderer, so the correct answer never sits in a habitual position.
  • A lint warns when the correct answer is the single longest option in 3+ questions (the tell readers used to game the original).
  • The identical CSS/JS/page scaffolding is factored into scripts/render.py — the agent writes plain Markdown, not ~250 lines of boilerplate HTML per run.

Usage

Write the explanation as Markdown (first # H1 is the title; a ## Quiz section uses - [ ]/- [x] checkbox options with indented feedback sub-bullets), then:

pip install markdown
python3 <skill>/scripts/render.py explanation.md

Output goes to /tmp/YYYY-MM-DD-explanation-<slug>.html (or -o <path>). See the docstring in scripts/render.py for the exact quiz syntax.

Agent installation

The one-liner above installs both skills for your agents via npx skills (Claude Code, Codex, Cursor, and others). Manual alternatives:

  • Hermes: copy a skill folder to ~/.hermes/skills/software-development/<skill>/
  • Claude Code: copy to ~/.claude/skills/<skill>/
  • Codex: paste the Procedure from the skill's SKILL.md into ~/.codex/prompts/<skill>.md

The renderer is agent-agnostic; each SKILL.md carries the full procedure and quality bar.

License

MIT

About

Agent skill pack: explain diffs/PRs and code questions as self-contained HTML explainers with interactive quiz, styled after shadcn/ui Typeset

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages