Repository navigation
Conversation
…t into documentation/ The README front page carried the whole capability readout inline and measured 84818 bytes. Three sections move out under their existing headings, byte for byte, into documentation/: the "What works today" body, the XML codec and cross-format equivalence section, and the Bundles, references, and Bulk NDJSON streaming section. Each keeps its heading in README.md above a short pointer at the point it left, so no heading is renamed and no line is dropped. documentation/ is this repo's durable-docs directory: CLAUDE.md points the narrative at documentation/agent-notes.md and the architecture records at its decisions subdirectory. It is also outside package.json "files" and outside the public surface the no-internal-refs gate scans, so the split changes neither the npm tarball contents nor that gate's reach. README.md: 84818 -> 8631 bytes, against a 22400-byte ceiling.
|
Superseded by #134, so closing this one unmerged. This PR split the README's capability readout into three pages under |
1 participant
Markdown only. No parse, mapping, profile, fixture or log line is touched.
What moved
README.mdcarried the whole capability readout inline and measured 84818 bytes, wellover the 22400-byte ceiling the umbrella spec
pipeline/active/S0308-submodule-agent-doc-budgets/children/fhir.mdbinds it to. Three sections move out under their existing headings, byte for byte:
## What works todaybodydocumentation/what-works-today.md### XML codec and cross-format equivalencedocumentation/xml-codec-and-cross-format-equivalence.md### Bundles, references, and Bulk NDJSON streamingdocumentation/bundles-references-and-ndjson-streaming.mdEvery heading stays in
README.mdat the point its section left, above a short pointer tothe new page. No heading is renamed, no line is deleted, and no link inside the moved text
needed re-basing because the moved text carries no markdown links.
README.md: 84818 -> 8631 bytes.Why
documentation/It is this repo's durable-docs directory already:
CLAUDE.mdpoints the narrative atdocumentation/agent-notes.mdand the architecture records at the decisions subdirectorybeside it. Two further properties matter here:
package.jsonfiles, so the npm tarball contents do not change.SURFACE_PATHSinscripts/check-no-internal-refs.sh, so the public-surfacegate keeps scanning exactly what it scanned before. The pointer link targets are checked
against that gate's internal-repo-path rule and none of them matches it.
Evidence
README.mdstill appears in the newREADME.mdorin one of the three new pages (
sort -uof the base againstsort -uof the four files,comm -23prints nothing).README.mdis still reachable fromREADME.mdor from a page it links to. Prints nothing.README.mdand over all three added files: no absolute link, nolink outside the repo, no missing target. Prints nothing.
npm pack --dry-runlists the same four entries before andafter (
CHANGELOG.md,LICENSE,README.md,package.json); onlyREADME.md's sizemoves, from 84.8 kB to 8.6 kB.
pnpm typecheck,pnpm lint,pnpm format:check,pnpm test(90 files, 2489 tests),
pnpm check:no-emdash,pnpm check:no-internal-refs,pnpm check:docs-set.