docs: give planning documents a default home (0.1.2) - #24
Merged
Merged
Conversation
The workflow named docs/plan/ and before_end_memory.md as examples and said plainly they were not prescribed. That left every project to invent a location, and it put a handoff file at the repository root, which is the least welcome place to leave one. Planning documents now default to .structured-coding/plans/<effort>/, one directory per effort. The directory already existed for the standards configuration, so this gives the toolkit one home in a project rather than two, and leaves the project's own docs/ tree alone. Grouping by effort keeps concurrent overall/step/PR hierarchies from colliding. It stays a default rather than a requirement. A project that already keeps plans elsewhere should keep them there; what matters is that one location is the authority and a later session can find it. The workflow's existing rule about using the repository's established documentation process is unchanged, and nothing refuses to work because of where a document sits. The standards reference now says what else lives in that directory, since a reader who found it through the configuration would otherwise have no reason to expect plans there. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_016cCs5DdUjLDkP8V3Z5x6XH
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.
Why
The workflow named
docs/plan/…andbefore_end_memory.mdas examples and said plainly they were not prescribed. Two consequences:Meanwhile
.structured-coding/already existed for the standards configuration, so a reader could reasonably expect plans there and find nothing.What changed
One home for the toolkit in a project instead of two, and the project's own
docs/tree is left alone. Grouping by effort keeps concurrent overall/step/PR hierarchies from colliding.It stays a default, not a requirement
A project that already keeps plans elsewhere should keep them there. What matters is that one location is the authority and a later session can find it. The existing rule about using the repository's established documentation process is unchanged, and nothing refuses to work because of where a document sits — consistent with everything here staying something a user can work around.
The reference also says to commit them if later sessions or teammates need to read them, which is usually the point of writing them down.
Also
The standards reference now says what else lives in that directory, since a reader who arrived through the configuration had no reason to expect plans there.
SKILL.mdand the three preserved prompts are untouched, so no specification baseline change.Validation
Ran 168 tests ... OK (skipped=1);--checkPASS on 6 translation pairs, the specification baseline, links and fences, and both packages. Both mirrors updated in lockstep with identical heading structure.Version bumped to 0.1.2, which
--check-hooksreports.🤖 Generated with Claude Code
https://claude.ai/code/session_016cCs5DdUjLDkP8V3Z5x6XH