SuperAPI AI Directory

scaffold-exercises

Coding & development

View repository

Updated 10-16 09:45

About this skill

Scaffold Exercises

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

Directory Naming

  • Sections:exercises/ under XX-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 TODOs
  • solution/ - reference implementation
  • explainer/ - 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

  1. Parse the plan - Extract section names, exercise names, and variant types
  2. Create directories - For each path, execute mkdir -p
  3. Create stub readmes - One readme.md
  4. Run lint - Execute pnpm ai-hero-cli internal lint validation
  5. 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/ or explainer.1/ exists
  • A non-empty readme.md
  • No .gitkeep files
  • No speaker-notes.md files
  • No broken links in readmes
  • No pnpm run exercise commands
  • Each subfolder needs main.ts

Moving/Renaming Exercises

When renumbering or moving exercises:

  1. Use git mv(not mv) to rename directories, preserving git history
  2. Update numeric prefixes to maintain order
  3. 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"