building-walkthroughs
Installation
SKILL.md
Building Walkthroughs
Setup
| Item | Kind | Required | When | Done when | How |
|---|---|---|---|---|---|
| Node.js 20.19+ with npm | user | required | Create, Update | node --version reports 20.19 or later |
https://nodejs.org |
| Root path | ask | required | Create | walkthrough-contract.md → Resolve walkthroughs root finds a root | Ask for the folder (default walkthroughs/); missing or empty → use it, else ask for another path; recorded as the root's location |
| Root marker | static | required | Create | <walkthroughs-root>/index.md carries walkthrough-contract.md → Author signature |
Write index.md from assets/index.md |
| Viewer app | static | required | Create, Update | The root's viewer files match assets/app/ |
Copy everything in assets/app/, dotfiles included (cp -R <skill>/assets/app/. <walkthroughs-root>/) |
| Viewer install | auto | required | Create, Update | <walkthroughs-root>/node_modules/ exists and the viewer did not change in this run |
npm install in the root |
| Standing rule | auto | required | Create | Root AGENTS.md has the line |
Add - When a change alters the app's screens, routes, or user tasks, run the building-walkthroughs Update recipe in the same work. to root AGENTS.md (create when missing) and to root CLAUDE.md when it exists without importing AGENTS.md; skip a file that has it |
Workflow
- Setup — for each Setup row whose When covers the request, in order: Done when holds → skip;
user→ stop and print its How when required, continue without it when optional;ask→ fill what the request answers, ask the rest together in one message, record each answer;autoandstatic→ run. - Contract — read walkthrough-contract.md.
- Recipe — match one Recipes row; open every doc in its Read column.