Skills scaffold-exercises
Create exercise directory structures with sections, problems, solutions, and explainers that pass linting. Use when user wants to scaffold exercises, create exercise stubs, or set up a new course section.
install
source · Clone the upstream repo
git clone https://github.com/mattpocock/skills
Claude Code · Install into ~/.claude/skills/
T=$(mktemp -d) && git clone --depth=1 https://github.com/mattpocock/skills "$T" && mkdir -p ~/.claude/skills && cp -r "$T/scaffold-exercises" ~/.claude/skills/mattpocock-skills-scaffold-exercises && rm -rf "$T"
manifest:
scaffold-exercises/SKILL.mdsource content
Scaffold Exercises
Create exercise directory structures that pass
pnpm ai-hero-cli internal lint, then commit with git commit.
Directory naming
- Sections:
insideXX-section-name/
(e.g.,exercises/
)01-retrieval-skill-building - Exercises:
inside a section (e.g.,XX.YY-exercise-name/
)01.03-retrieval-with-bm25 - Section number =
, exercise number =XXXX.YY - Names are dash-case (lowercase, hyphens)
Exercise variants
Each exercise needs at least one of these subfolders:
- student workspace with TODOsproblem/
- reference implementationsolution/
- conceptual material, no TODOsexplainer/
When stubbing, default to
explainer/ unless the plan specifies otherwise.
Required files
Each subfolder (
problem/, solution/, explainer/) needs a readme.md that:
- Is not empty (must have real content, even a single title line works)
- Has no broken links
When stubbing, create a minimal readme with a title and a description:
# Exercise Title Description here
If the subfolder has code, it also needs a
main.ts (>1 line). But for stubs, a readme-only exercise is fine.
Workflow
- Parse the plan - extract section names, exercise names, and variant types
- Create directories -
for each pathmkdir -p - Create stub readmes - one
per variant folder with a titlereadme.md - Run lint -
to validatepnpm ai-hero-cli internal lint - Fix any errors - iterate until lint passes
Lint rules summary
The linter (
pnpm ai-hero-cli internal lint) checks:
- Each exercise has subfolders (
,problem/
,solution/
)explainer/ - At least one of
,problem/
, orexplainer/
existsexplainer.1/
exists and is non-empty in the primary subfolderreadme.md- No
files.gitkeep - No
filesspeaker-notes.md - No broken links in readmes
- No
commands in readmespnpm run exercise
required per subfolder unless it's readme-onlymain.ts
Moving/renaming exercises
When renumbering or moving exercises:
- Use
(notgit mv
) to rename directories - preserves git historymv - Update the numeric prefix to maintain order
- Re-run lint after moves
Example:
git mv exercises/01-retrieval/01.03-embeddings exercises/01-retrieval/01.04-embeddings
Example: stubbing from a plan
Given a plan like:
Section 05: Memory Skill Building - 05.01 Introduction to Memory - 05.02 Short-term Memory (explainer + problem + solution) - 05.03 Long-term Memory
Create:
mkdir -p exercises/05-memory-skill-building/05.01-introduction-to-memory/explainer mkdir -p exercises/05-memory-skill-building/05.02-short-term-memory/{explainer,problem,solution} mkdir -p exercises/05-memory-skill-building/05.03-long-term-memory/explainer
Then create readme stubs:
exercises/05-memory-skill-building/05.01-introduction-to-memory/explainer/readme.md -> "# Introduction to Memory" exercises/05-memory-skill-building/05.02-short-term-memory/explainer/readme.md -> "# Short-term Memory" exercises/05-memory-skill-building/05.02-short-term-memory/problem/readme.md -> "# Short-term Memory" exercises/05-memory-skill-building/05.02-short-term-memory/solution/readme.md -> "# Short-term Memory" exercises/05-memory-skill-building/05.03-long-term-memory/explainer/readme.md -> "# Long-term Memory"