scaffold-exercises

Solid

Create exercise directory structures with sections, problems, solutions, and explainers that pass linting. Use when user wants to scaffold exercises, create exercise stubs, or set up a new course section.

AI & Automation 485 stars 58 forks Updated today MIT

Install

View on GitHub

Quality Score: 91/100

Stars 20%
89
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# Scaffold Exercises Create exercise directory structures that pass `pnpm ai-hero-cli internal lint`, then commit with `git commit`. ## Directory naming - **Sections**: `XX-section-name/` inside `exercises/` (e.g., `01-retrieval-skill-building`) - **Exercises**: `XX.YY-exercise-name/` inside a section (e.g., `01.03-retrieval-with-bm25`) - Section number = `XX`, exercise number = `XX.YY` - Names are dash-case (lowercase, hyphens) ## Exercise variants Each exercise needs at least one of these subfolders: - `problem/` - student workspace with TODOs - `solution/` - reference implementation - `explainer/` - conceptual material, no TODOs When stubbing, default to `explainer/` unless the plan specifies otherwise. ## Required files Each subfolder (`problem/`, `solution/`, `explainer/`) needs a `readme.md` that: - Is **not empty** (must have real content, even a single title line works) - Has no broken links When stubbing, create a minimal readme with a title and a description: ```md # Exercise Title Description here ``` 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 2. **Create directories** - `mkdir -p` for each path 3. **Create stub readmes** - one `readme.md` per variant folder with a title 4. **Run lint** - `pnpm ai-hero-cli internal lint` to validate 5. **Fix any errors** - iterate until lint passes ## Lint ...

Details

Author
stevesolun
Repository
stevesolun/ctx
Created
2 months ago
Last Updated
today
Language
Python
License
MIT

Integrates with

Similar Skills

Semantically similar based on skill content — not just same category