Scaffold Exercises
创建能通过 pnpm ai-hero-cli internal lint 的 exercise directory structures,然后用 git commit 提交。
Directory naming
- Sections:
exercises/下的XX-section-name/(例如01-retrieval-skill-building) - Exercises:section 下的
XX.YY-exercise-name/(例如01.03-retrieval-with-bm25) - Section number =
XX,exercise number =XX.YY - Names 使用 dash-case(小写、连字符)
Exercise variants
每个 exercise 至少需要这些 subfolders 中的一个:
problem/— student workspace,包含 TODOssolution/— reference implementationexplainer/— conceptual material,不含 TODOs
创建 stub 时,除非 plan 指定其他 variant,否则默认使用 explainer/。
Required files
每个 subfolder(problem/、solution/、explainer/)都需要一个 readme.md,要求:
- 非空(必须有真实内容,即使只有一行 title 也可以)
- 没有 broken links
创建 stub 时,生成带 title 和 description 的最小 readme:
# Exercise Title
Description here
如果 subfolder 有 code,还需要 main.ts(>1 行)。但对 stubs 来说,readme-only exercise 可以接受。
Workflow
- Parse the plan — 提取 section names、exercise names 和 variant types
- Create directories — 对每个 path 执行
mkdir -p - Create stub readmes — 每个 variant folder 一个带 title 的
readme.md - Run lint — 执行
pnpm ai-hero-cli internal lint验证 - Fix any errors — 迭代直到 lint 通过
Lint rules summary
linter(pnpm ai-hero-cli internal lint)检查:
- 每个 exercise 有 subfolders(
problem/、solution/、explainer/) - 至少存在
problem/、explainer/或explainer.1/之一 - primary subfolder 中存在非空
readme.md - 没有
.gitkeepfiles - 没有
speaker-notes.mdfiles - readmes 中没有 broken links
- readmes 中没有
pnpm run exercisecommands - 除非是 readme-only,否则每个 subfolder 都需要
main.ts
Moving/renaming exercises
重新编号或移动 exercises 时:
- 使用
git mv(不是mv)重命名 directories,保留 git history - 更新 numeric prefix 以维持顺序
- 移动后重新运行 lint
Example:
git mv exercises/01-retrieval/01.03-embeddings exercises/01-retrieval/01.04-embeddings
Example: stubbing from a plan
给定这样的 plan:
Section 05: Memory Skill Building
- 05.01 Introduction to Memory
- 05.02 Short-term Memory (explainer + problem + solution)
- 05.03 Long-term Memory
创建:
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
然后创建 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"
