Ship a worked example session in the repo - #3
Merged
Conversation
A complete six-phase session copied as-if from a project's artifacts folder: requirement, research with a recorded decision, a critiqued three-step plan, self-contained step files per references/step-format.md, and an execution log where every step closes on a named check. README links it from Quickstart and the repo tree.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds
examples/001-api-rate-limiter: a complete, finished session as the workflow would leave it on disk after Phase 6 chose Keep.What's inside
session.json— final state (wrapup,complete) matching the session schemarequirement.md— scoped problem with checkable success criteria and the Q&A transcriptresearch/— one topic file, two recorded decisions, summary, andnotes.mdshowing discoveries folded back into steps during executionplan.md— step table, dependency graph, and a critique that caught a real gap (wall-clock coupling → injectablenow)steps/step-001..003.md— self-contained perreferences/step-format.md: context copied inline, exact paths, patterns shown, binary acceptance, rollbackexecution-log.md— every step closed by a named check with its result; final review found and fixed one off-by-one before convergingexamples/README.md— reading order and what to look atThe target codebase (an Express orders API gaining a token-bucket rate limiter) is fictional but internally consistent across all artifacts.
Stacked on #1 (six-phase revision) — the example uses the six-phase layout (
wrapup), so merge #1 first; GitHub will retarget this PR tomainwhen the base branch is deleted.Ticks the second roadmap item.
🤖 Generated with Claude Code