Skip to content

docs: describe the XML substrate and the fatal list precisely - #143

Merged
NSchatz merged 1 commit into
mainfrom
docs/claims-0-1-0-holds
Oct 7, 2026
Merged

NSchatz merged 1 commit into
mainfrom
docs/claims-0-1-0-holds

Conversation

@NSchatz

@NSchatz NSchatz commented Oct 7, 2026 •

Copy link
Copy Markdown
Contributor

Two wording changes in the README and docs-content, checked on the published @cosyte/ccda 0.1.0 from a clean install outside any repository (Node 24.21.0), on a synthetic CCD generated by @cosyte/synth 0.1.0: XML that does not parse throws NOT_WELL_FORMED_XML, and a DOCTYPE with an external entity throws XXE_OR_DTD_PRESENT.

File Before After
README.md (twice) (exact-pinned), the hardened W3C-DOM substrate for C-CDA's XML. (exact-pinned), the W3C-DOM substrate for C-CDA's XML.
README.md ..., malformed XML, a non-ClinicalDocument root) is always a thrown CcdaParseError ..., XML that does not parse, a non-ClinicalDocument root) ...
docs-content/installation.md the hardened W3C-DOM substrate @xmldom/xmldom the W3C-DOM substrate @xmldom/xmldom
docs-content/intro.md the hardened W3C-DOM substrate @xmldom/xmldom (exact-pinned), configured XXE-safe the W3C-DOM substrate @xmldom/xmldom (exact-pinned), configured XXE-safe
docs-content/intro.md ..., malformed XML, a non-ClinicalDocument root) always throws. ..., XML that does not parse, a non-ClinicalDocument root) always throws.
docs-content/quickstart.md throws a typed CcdaParseError: malformed XML, a non-ClinicalDocument root, throws a typed CcdaParseError: XML that does not parse, a non-ClinicalDocument root,
docs-content/spec-notes-tolerance.md (Tier 3 row) Malformed XML, a non-ClinicalDocument root, a security tripwire. XML that does not parse, a non-ClinicalDocument root, a security tripwire.
docs-content/spec-notes-tolerance.md raised by the hardened XML substrate raised by the XML substrate

No runnable block changes; prettier --check passes on every changed file with @cosyte/prettier-config.

https://claude.ai/code/session_011dC8vE9axM3hqC8rNEX3W9

- "the hardened W3C-DOM substrate" becomes "the W3C-DOM substrate", and
  "the hardened XML substrate" becomes "the XML substrate".
  "configured XXE-safe" stays.
- In the list of input that always throws, "malformed XML" becomes "XML
  that does not parse".

Checked on the published 0.1.0 from a clean install: XML that does not
parse throws NOT_WELL_FORMED_XML, and a DOCTYPE with an external entity
throws XXE_OR_DTD_PRESENT.

Claude-Session: https://claude.ai/code/session_011dC8vE9axM3hqC8rNEX3W9
@NSchatz NSchatz changed the title docs: claim only what the 0.1.0 XML substrate does docs: describe the XML substrate and the fatal list precisely Oct 7, 2026
@NSchatz
NSchatz force-pushed the docs/claims-0-1-0-holds branch from 7c950c3 to 0208cce Compare October 7, 2026 22:40
@NSchatz
NSchatz merged commit be6e5be into main Oct 7, 2026
11 checks passed
@NSchatz
NSchatz deleted the docs/claims-0-1-0-holds branch October 7, 2026 22:44
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.

1 participant