Skip to content

docs(plans): the internal plans are out of the public tree - #420

Merged
developerz-ai[bot] merged 1 commit into
mainfrom
docs/plans-out-of-the-public-tree
Nov 14, 2026
Merged

developerz-ai[bot] merged 1 commit into
mainfrom
docs/plans-out-of-the-public-tree

Conversation

@dinndev2

Copy link
Copy Markdown
Contributor

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.md describes what remains: prompt-design.md, plans/, and a pointer to the CLI's user docs under packages/aitm/docs/.
  • Nothing dangles. 15 source and test comments cited a plan file as provenance ("See docs/plans/…/03-….md"). Each keeps its reasoning and drops only the path, so no comment points at a removed file. No markdown linked into the removed plans, and no remaining file names a removed plan folder.
  • The public-tree guard asserted it had checked at least one plan tracker, which fails on an empty tree. It now asserts it read and checked every tracker git lists, which is stricter where trackers exist and correct where there are none. A new self-test pins the tracker pattern to the layout docs/plans/README.md documents, 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.
  • The guard still bites. A plan tracker naming a person, staged so git ls-files sees it, fails names roles, not people, in every plan tracker. A drifted tracker pattern fails matches 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 includes doc-links.test.ts.
  • bun run lint, bun run typecheck, bun run typecheck:tests: clean. 0 broken relative links outside docs/vendor/.

The published package is unaffected: it ships dist, the README and the licence only.

Closes #384

🤖 Generated with Claude Code

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>
@developerz-ai

developerz-ai Bot commented Nov 14, 2026 •

Copy link
Copy Markdown
Contributor

✅ Reviewed — nothing blocking

0 actionable comment(s) · grounded on your code

🤖 developerz.ai — automated review, running on your model and your box.

@developerz-ai developerz-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

@developerz-ai
developerz-ai Bot merged commit 848efae into main Nov 14, 2026
5 checks passed
@developerz-ai
developerz-ai Bot deleted the docs/plans-out-of-the-public-tree branch November 14, 2026 09:15
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.

docs(plans): the internal plans are working documents, not public documentation

1 participant