docs(internal): correct the Layout block against the real src/ tree - #188
Merged
Conversation
The Layout block listed six packages — testbed, recorder, compiler, runner, cache, metrics — but `ls src/` shows nine directories plus src/cli.ts. intent/ (#124), session/ (#98, SC-05) and shared/ (#74) all landed after the block was written, and the paragent binary after that. A new agent orienting from this file would not learn that the consent gate or the intent resolver exist, which is the one job this section has. Regrouped to match architecture.md: the binary, seven pipeline packages in dataflow order, then the two leaves that are not stages. Also drops the "Content is unchanged" claim in the header note, which this commit makes false, and records the correction under Open questions. No status, track, or verdict touched. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
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.
Summary
Audit of
docs/README-internal.mdafter the npm publish (#185), checking for staleness.The publication claims were fine — this file's Quick Start is the contributor one (
git clone+npm run ci), which publishing does not affect. It makes nonpxor registry claims at all.The Layout block was not fine. It listed six
src/packages:ls src/shows nine directories plussrc/cli.ts. Missing:intent/(#124),session/(#98 / SC-05),shared/(#74), and theparagentbinary — all landed after the block was written.That matters more than a typo: a new agent orienting from this file would not learn that the consent gate or the intent resolver exist, and orienting new agents is the one job this section has. Regrouped to match architecture.md's framing — the binary, seven pipeline packages in dataflow order, then the two leaves that are not stages.
Also drops "Content is unchanged" from the header note, which this commit makes false, and records the correction under Open questions so the move-provenance claim stays honest.
Test plan
ls -d src/*/andls src/*.tsexactly — nine directories plussrc/cli.tsdocs/architecture.md(intent → testbed → recorder → compiler → cache → runner → metrics)shared/andsession/grouped as leaves, per architecture.md's "not pipeline stages"npm run lint:docs— clean (68 docs)Not changed
Two Open-questions bullets remain live and are not mine to close: the
owner: B0guess, and whether coding agents that hardcodeREADME.mdnow land on the visitor page (the suggested fix there is a rootAGENTS.mdpointer).