scaffold-exercises

Original：🇨🇳 Chinese

Translated

Create an exercise directory structure containing section, problem, solution, and explainer that passes lint checks. Use this when users want to build an exercise framework, create exercise templates, or set up new course chapters.

2installs

Sourcedevcxl/mattpocock-skills-zh

Added on2026-08-13

NPX Install

npx skill4agent add devcxl/mattpocock-skills-zh scaffold-exercises

SKILL.md Content (Chinese)

View Translation Comparison →

Set Up Exercise Framework

Create an exercise directory structure that passes the

pnpm ai-hero-cli internal lint

check, then commit using

git commit

.

Directory Naming Rules

Sections: Located under

exercises/

in the format

XX-section-name/

(e.g.,

01-retrieval-skill-building

)

Exercises: Located within sections in the format
```
XX.YY-exercise-name/
```
(e.g.,
```
01.03-retrieval-with-bm25
```
)
Section number =
```
XX
```
, Exercise number =
```
XX.YY
```
Names use kebab-case (lowercase letters, hyphens)

Exercise Variants

Each exercise requires at least one of the following subfolders:

```
problem/
```
— Student workspace containing TODOs
```
solution/
```
— Reference implementation
```
explainer/
```
— Concept explanation materials without TODOs

When creating templates, use

explainer/

by default unless specified otherwise in the plan.

Required Files

Each subfolder (

problem/

,

solution/

,

explainer/

) needs a

readme.md

with the following requirements:

Cannot be empty (must have actual content, even just a one-line title is acceptable)
No broken links

When creating templates, create a minimal readme with a title and description:

md

# Exercise Title

Description here

If the subfolder contains code, a

main.ts

(with more than 1 line) is also required. However, for templates, exercises with only a readme are acceptable.

Workflow

Parse the Plan — Extract section names, exercise names, and variant types
Create Directories — Use
```
mkdir -p
```
to create each path
Create Readme Templates — One
```
readme.md
```
per variant folder with a title
Run Lint — Execute
```
pnpm ai-hero-cli internal lint
```
for validation
Fix Errors — Revise repeatedly until lint passes

Lint Rules Summary

The linter (

pnpm ai-hero-cli internal lint

) checks the following:

Each exercise has subfolders (
```
problem/
```
,
```
solution/
```
,
```
explainer/
```
)
At least one of
```
problem/
```
,
```
explainer/
```
, or
```
explainer.1/
```
exists
```
readme.md
```
exists in main subfolders and is not empty
No
```
.gitkeep
```
files
No
```
speaker-notes.md
```
files
No broken links in readme
No
```
pnpm run exercise
```
commands in readme
Each subfolder requires
```
main.ts
```
unless it only has a readme

Moving/Renaming Exercises

When renumbering or moving exercises:

Use
```
git mv
```
(instead of
```
mv
```
) to rename directories — this preserves git history
Update numeric prefixes to maintain order
Re-run lint after moving

Example:

bash

git mv exercises/01-retrieval/01.03-embeddings exercises/01-retrieval/01.04-embeddings

Example: Create Template from 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: