Skip to content

refactor: rename the step model to the beat model - #200

Merged
mnaimfaizy merged 2 commits into
mainfrom
refactor/beat-model
Oct 11, 2026
Merged

mnaimfaizy merged 2 commits into
mainfrom
refactor/beat-model

Conversation

@mnaimfaizy

Copy link
Copy Markdown
Owner

Summary

Stacked on #199 (base branch docs/playground-adr-0004). Merge #199 first, then retarget this to main.

A rename with no behaviour change. CONTEXT.md and ADR 0004 reserve "step" for a moment of a Playground trace; a story is made of beats and its data is the beat model.

  • Code: StoryStep → StoryBeat, STORY_STEPS → STORY_BEATS, and the 2D/3D view prop step → beat in the JavaScript and Git stories. StoryBeat rather than Beat because the scenario already has ScenarioBeat.
  • Visible text: the story counter reads "Beat n / N", and the buttons are "Previous beat" / "Next beat", as the scenario already did. "A 10-step story" becomes "A 10-beat story".
  • Agents and docs: skill step-model → beat-model; agent definitions, AGENTS.md, the 3D standard, ADRs 0001 and 0003 and the verify-viz overlap script follow. Generated copies come from npm run agents:sync.

"Step" stays where it is a verb ("step forward"), a numeric step (ZOOM_STEP), an ARIA token (aria-current="step"), or the Playground's own term. ADR 0001 keeps its file name so links keep working.

Checks

  • npx tsc -b, npm run lint, npm run test:run (33 files, 340 tests) and npm run build pass.
  • npm run agents:check passes.
  • In a browser, the Stack ↔ Heap story shows "Beat 2 / 10" after pressing "Next beat", with no console errors. The Git stories were checked through their tests only.

Not in this PR

  • docs/3D-Visualization-Standard.md still says its prototype's hand-authored beats should later be replaced with Playground traces, which ADR 0004 rules out. That is a change of meaning, left for the owner.
  • docs/RESEARCH/** keeps the old term as a record of what was true when written.

🤖 Generated with Claude Code

mnaimfaizy and others added 2 commits October 11, 2026 15:42
Record the decision that Playground traces share the story snapshot and
the 2D/3D views, are recorded by AST instrumentation, and that there is
exactly one (dark) Playground. Extend CONTEXT.md with the Playground
vocabulary (trace, step, snapshot, lens, console, example, exercise) and
the story terms that were in use but undefined. Add the October 2026
playground audit and the design research the decision rests on.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
CONTEXT.md and ADR 0004 reserve "step" for a moment of a Playground
trace. A story is made of beats and its data is the beat model.

- Code: StoryStep -> StoryBeat, STORY_STEPS -> STORY_BEATS, view prop
  step -> beat in the JavaScript and Git stories.
- UI: the story counter reads "Beat n / N" and the buttons are
  "Previous beat" / "Next beat", as the scenario already did.
- Skill step-model -> beat-model; agent definitions, AGENTS.md, the 3D
  standard, ADRs 0001 and 0003 and the verify-viz script follow.
  Generated copies are regenerated by agents:sync.

No behaviour change. ADR 0001 keeps its file name.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Base automatically changed from docs/playground-adr-0004 to main October 11, 2026 08:52
@mnaimfaizy mnaimfaizy self-assigned this Oct 11, 2026
@mnaimfaizy
mnaimfaizy merged commit 35754cf into main Oct 11, 2026
1 check passed
@mnaimfaizy
mnaimfaizy deleted the refactor/beat-model branch October 11, 2026 09:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant