scaffold-exercises

Scaffold Exercises

Create an exercise directory structure that passes pnpm ai-hero-cli internal lint , then commit with git commit .

Create exercise directory structures that pass pnpm ai-hero-cli internal lint, then commit with git commit.

Directory naming

• Sections：exercises/ within XX-section-name/(for example 01-retrieval-skill-building）

  Sections: XX-section-name/ inside exercises/ (e.g., 01-retrieval-skill-building)

• Exercises: XX.YY-exercise-name/within a section (for example 01.03-retrieval-with-bm25）

  Exercises: XX.YY-exercise-name/ inside a section (e.g., 01.03-retrieval-with-bm25)

• Section number = XX, exercise number = XX.YY

  Section number = XX, exercise number = XX.YY

• Names use kebab-case (lowercase, hyphens)

  Names are dash-case (lowercase, hyphens)

Exercise variants

Each exercise needs at least one of the following subfolders:

Each exercise needs at least one of these subfolders:

• problem/ - Student workspace, containing TODOs

  problem/ - student workspace with TODOs

• solution/ - Reference implementation

  solution/ - reference implementation

• explainer/ - Concept material, no TODOs

  explainer/ - conceptual material, no TODOs

When creating stubs, use explainer/by default, unless the plan says otherwise.

When stubbing, default to explainer/ unless the plan specifies otherwise.

Required files

Each subfolder (problem/、solution/、explainer/) needs a readme.md, which:

Each subfolder (problem/, solution/, explainer/) needs a readme.md that:

• Cannot be empty(must have actual content, even just a one-line title is fine)

  Is not empty (must have real content, even a single title line works)

• Has no broken links

  Has no broken links

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

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(more than 1 line). But for stubs, an exercise with only a readme is also fine.

If the subfolder has code, it also needs a main.ts (>1 line). But for stubs, a readme-only exercise is fine.

Workflow

1. Parse the plan - Extract section names, exercise names, and variant types

   Parse the plan - extract section names, exercise names, and variant types

2. Create directories - For each path, run mkdir -p

   Create directories - mkdir -p for each path

3. Create stub readmes - One readme.md

   Create stub readmes - one readme.md per variant folder with a title

4. Run lint - pnpm ai-hero-cli internal lint to validate

   Run lint - pnpm ai-hero-cli internal lint to validate

5. Fix errors - Iterate until lint passes

   Fix any errors - iterate until lint passes

Lint rules summary

The lint tool (pnpm ai-hero-cli internal lint) checks:

The linter (pnpm ai-hero-cli internal lint) checks:

• Every exercise has subfolders (problem/、solution/、explainer/）

  Each exercise has subfolders (problem/, solution/, explainer/)

• At least one of problem/、explainer/ or explainer.1/ exists

  At least one of problem/, explainer/, or explainer.1/ exists

• A present and non-empty readme.md

  readme.md exists and is non-empty in the primary subfolder

• No .gitkeep files

  No .gitkeep files

• No speaker-notes.md files

  No speaker-notes.md files

• No broken links in readmes

  No broken links in readmes

• No pnpm run exercise commands in readmes

  No pnpm run exercise commands in readmes

• Every subfolder needs a main.ts, unless it only has a readme

  main.ts required per subfolder unless it's readme-only

Moving/renaming exercises

When renumbering or moving exercises:

When renumbering or moving exercises:

1. Use git mv(not mv) to rename directories - preserves git history

   Use git mv (not mv) to rename directories - preserves git history

2. Update numeric prefixes to keep the order

   Update the numeric prefix to maintain order

3. Re-run lint after moving

   Re-run lint after moves

Example:

Example:

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

Example: stubbing from a plan

Given the following 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:

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:

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"