Conversation
… documentation/ README.md measured 71047 bytes and CLAUDE.md 33825, both over the budget the umbrella holds for a submodule's published README and its agent doc. Whole sections move, under the headings they already had, into documentation/, and each heading they left behind now sits above a link to the file that carries it. README.md is 18741 bytes: the API reference, the compatibility notes, the cookbook, the full known-limitations list and the positioning paragraph are in documentation/readme-*.md. CLAUDE.md is 11518 bytes and 93 lines: the trap list is in documentation/claude-traps.md, with its anchors re-based by one directory. Nothing is deleted. Every non-blank line both files carried at 460d9f1 is still present, byte for byte, in the reduced file or in a file it links to. The only edits to moved text are relative links re-based by one directory, plus a link to a CONTRIBUTING.md this repository does not carry, which is now plain text rather than a link resolving nowhere. What stays in the README is what the house skeleton and this repository's own suite pin there: why the package exists, status, install, usage, the PHI and safety statement, the temporal declaration a de-identified object makes about its own dates, and the two known limitations a consumer has to act on. No source file, fixture, log line or listener is touched.
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.
Spec:
pipeline/active/S0308-submodule-agent-doc-budgets/children/dicom.mdin the cosyte umbrella.What this does
README.mdgoes from 71047 to 18741 bytes andCLAUDE.mdfrom 33825 to 11518 bytes (232 lines to93). Whole sections move, under the headings they already had, into
documentation/, and everyheading they left behind now sits above a link to the file that carries it:
## Why this existsdocumentation/readme-why-this-exists.md## API,### Access patterns,### Error Handlingdocumentation/readme-api.md## Compatibilityand its three subsectionsdocumentation/readme-compatibility.md## Cookbook,### De-identify before sharingdocumentation/readme-cookbook.md## Known limitations & non-goalsdocumentation/readme-known-limitations.md## Traps that cost a defect to learndocumentation/claude-traps.mddocumentation/is this repository's own home for durable documentation:CLAUDE.mdalready sendsrelocated narrative to
documentation/agent-notes.md, andscripts/check-no-internal-refs.tsclassifies the directory as agent context rather than a consumer surface.
Nothing was deleted
Every non-blank line both files carried before this change is still present, byte for byte, in the
reduced file or in a file it links to. The only edits to moved text are relative links re-based by
one directory (
documentation/agent-notes.md#xbecomesagent-notes.md#x,./src/parser/warnings.tsbecomes
../src/parser/warnings.ts), plus a link to aCONTRIBUTING.mdthis repository does notcarry, which is now plain text rather than a link that resolves nowhere.
What stays in the README is what the house skeleton in
test/docs/readme-structure.test.tsand thisrepository's own prose gates pin there: why the package exists, status, install, usage, the PHI and
safety statement, the temporal declaration a de-identified object makes about its own dates, and the
two known limitations a consumer has to act on.
Evidence
files, so no heading the file carried is unreachable from it.
link is repo-relative, inside this repository, and resolves.
pnpm test: 1654 passed, 1 failed. The failure istest/scripts/phi-scan-matchers.test.tstiming out at 10s under full-suite load; that file passes on its own (32 passed, 23s of test
time) and reads a throwaway README under a temporary root, never this one.
pnpm exec vitest run test/docs test/conversion-surface.test.ts: 166 passed.pnpm run format:check,pnpm run check:no-emdash,pnpm run check:no-internal-refs,pnpm phi-scan,pnpm typecheck,pnpm lint: all OK.npm pack --dry-run: 11 files, unchanged, becausepackage.jsonfilesis untouched anddocumentation/was never in it. The published tarball differs only in the bytes ofREADME.md.Blast radius
Markdown only. No parser, mapping, fixture, log line or listener is touched, and no public export,
warning code or behaviour changes.