Create exercise directory structures that pass pnpm ai-hero-cli internal lint , then commit with git commit .
Directory Naming
- Sections:
exercises/underXX-section-name/(e.g.01-retrieval-skill-building) - Exercises:
XX.YY-exercise-name/under section (e.g.01.03-retrieval-with-bm25) - Section number =
XX,exercise number =XX.YY - Names use dash-case (lowercase, hyphens)
Exercise Variants
Each exercise needs at least one of these subfolders:
problem/- student workspace, containing TODOssolution/- reference implementationexplainer/- conceptual material, without TODOs
When creating stubs, use explainer/。
Required Files
Each subfolder (problem/、solution/、explainer/) needs a readme.md, requiring:
- Non-empty(must have real content, even just a one-line title is fine)
- No broken links
When creating stubs, generate a minimal readme with a title and description:
# Exercise Title
Description here
If the subfolder has code, it also needs main.ts(>1 line). But for stubs, a readme-only exercise is acceptable.
Workflow
- Parse the plan - Extract section names, exercise names, and variant types
- Create directories - For each path, execute
mkdir -p - Create stub readmes - One
readme.md - Run lint - Execute
pnpm ai-hero-cli internal lintvalidation - Fix any errors - Iterate until lint passes
Lint Rules Summary
linter(pnpm ai-hero-cli internal lint) checks:
- Each exercise has subfolders (
problem/、solution/、explainer/) - At least one of
problem/、explainer/orexplainer.1/exists - A non-empty
readme.md - No
.gitkeepfiles - No
speaker-notes.mdfiles - No broken links in readmes
- No
pnpm run exercisecommands - Each subfolder needs
main.ts
Moving/Renaming Exercises
When renumbering or moving exercises:
- Use
git mv(notmv) to rename directories, preserving git history - Update numeric prefixes to maintain order
- Re-run lint after moving
Example:
git mv exercises/01-retrieval/01.03-embeddings exercises/01-retrieval/01.04-embeddings
Example: Generating Stubs from a Plan
Given a plan like this:
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"