搭建习题脚手架

创建能通过 pnpm ai-hero-cli internal lint 的习题目录结构,然后用 git commit 提交。

目录命名

  • 章节exercises/ 内的 XX-section-name/(例如 01-retrieval-skill-building
  • 习题:章节内的 XX.YY-exercise-name/(例如 01.03-retrieval-with-bm25
  • 章节编号 = XX,习题编号 = XX.YY
  • 名称使用 dash-case(小写、连字符)

习题变体

每个习题至少需要以下子文件夹之一:

  • problem/ — 学生工作区,含 TODO
  • solution/ — 参考实现
  • explainer/ — 概念材料,无 TODO

搭建存根时,除非计划另有说明,默认使用 explainer/

必需文件

每个子文件夹(problem/solution/explainer/)都需要一个 readme.md,要求:

  • 非空(必须有实际内容,哪怕只有一行标题也可以)
  • 无损坏链接

搭建存根时,创建最小 readme,包含标题和描述:

# Exercise Title

Description here

如果子文件夹有代码,还需要 main.ts(>1 行)。但对存根而言,仅含 readme 的习题也可以。

工作流

  1. 解析计划 — 提取章节名、习题名和变体类型
  2. 创建目录 — 为每个路径执行 mkdir -p
  3. 创建 readme 存根 — 每个变体文件夹一个带标题的 readme.md
  4. 运行 lintpnpm ai-hero-cli internal lint 验证
  5. 修复错误 — 迭代直到 lint 通过

Lint 规则摘要

linter(pnpm ai-hero-cli internal lint)检查:

  • 每个习题有子文件夹(problem/solution/explainer/
  • 至少存在 problem/explainer/explainer.1/ 之一
  • 主变体子文件夹中存在且非空的 readme.md
  • .gitkeep 文件
  • speaker-notes.md 文件
  • readme 中无损坏链接
  • readme 中无 pnpm run exercise 命令
  • 每个子文件夹需要 main.ts,除非是仅 readme 的习题

移动/重命名习题

重新编号或移动习题时:

  1. 使用 git mv(不是 mv)重命名目录——保留 git 历史
  2. 更新数字前缀以保持顺序
  3. 移动后重新运行 lint

示例:

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

示例:根据计划搭建存根

给定如下计划:

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 存根:

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"