Repository navigation
docs(plans): the internal plans are out of the public tree - #420
Merged
Merged
Conversation
The 62 plan documents under docs/plans/2026/ were the team's working documents, not user documentation; git history keeps them. docs/plans/README.md keeps the layout /planx writes to, docs/README.md describes what remains, and the source comments that cited a plan file keep their reasoning without the path. The public-tree guard now checks every tracker git lists rather than at least one, and pins its tracker pattern to the documented layout. Closes #384 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
4 tasks
Contributor
✅ Reviewed — nothing blocking0 actionable comment(s) · grounded on your code 🤖 developerz.ai — automated review, running on your model and your box. |
Contributor
There was a problem hiding this comment.
Review summary — 73 file(s), 0 finding(s).
Removes paths to the deleted internal plan files from source and test comments, adds a plans README, and changes the plan-tracker check to require every tracked tracker to be read and checked, with a self-test that pins the tracker pattern.
🤖 developerz.ai review — automated, running on your model and your box. What is this?
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
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.
What
The 62 internal plan documents under
docs/plans/2026/are out of the public tree. They were the team's working documents (bug hunts, audit remediation, improvement plans and their trackers), not user documentation. Git history is untouched. This follows how the sibling router repository handled the same class.docs/plans/README.md(new) keeps the directory meaningful for/planx, which still writes there: the layout, the conventions, and one rule for anything written there from now on (trackers name roles, never people; no home directories or workspace layouts, because the tree is public).docs/README.mddescribes what remains:prompt-design.md,plans/, and a pointer to the CLI's user docs underpackages/aitm/docs/.docs/plans/README.mddocuments, so a drifted pattern can't quietly turn the rule into a scan of nothing.Verification
public-tree.test.ts: 16/16 under Node and Bun.git ls-filessees it, failsnames roles, not people, in every plan tracker. A drifted tracker pattern failsmatches the tracker path the plan layout writes, and nothing else.npm run test:integration -w @developerz.ai/aitm: 74 pass, 0 fail, 5 skipped (the e2e smoke tests need secrets). That includesdoc-links.test.ts.bun run lint,bun run typecheck,bun run typecheck:tests: clean. 0 broken relative links outsidedocs/vendor/.The published package is unaffected: it ships
dist, the README and the licence only.Closes #384
🤖 Generated with Claude Code