Skip to content

docs(documents.js): fix Fidelity table drift and add rtf's row/column - #862

Merged
Mearman merged 1 commit into
mainfrom
docs/documents-js-fidelity-table-audit
Sep 3, 2026
Merged

docs(documents.js): fix Fidelity table drift and add rtf's row/column#862
Mearman merged 1 commit into
mainfrom
docs/documents-js-fidelity-table-audit

Conversation

@Mearman

@Mearman Mearman commented Sep 3, 2026

Copy link
Copy Markdown
Member

Summary

  • Audits every cell in the documents.js package README's Fidelity table against the real composition-engine pathfinder (resolveCompositionPlan), fixing the widespread --vs-routable drift the table accumulated after it was hand-written against a small set of named convenience functions and never updated once the pathfinder started generating the full cross-product of same-variant and cross-variant-transform edges.
  • Adds rtf's own row and column, rated from rtf-codec's documented Scope crossed with the routes the pathfinder actually resolves for it.
  • Updates the table's summary line to 129 of 156 and the surrounding prose describing the same-variant/markdown/cross-variant-transform bridge families to match.

Fixes #853

Test plan

  • Verified every one of the 156 ordered pairs against a throwaway script calling resolveCompositionPlan directly (not committed, per the issue's own suggestion to weigh a generator script against a verified manual edit -- see PR description below for why a manual edit was judged more proportionate here).
  • pnpm --dir packages/documents.js lint and typecheck pass (README-only change; no source touched).
  • Pre-push hook ran the full workspace lint/typecheck/test suite, all green.

@Mearman
Mearman marked this pull request as ready for review September 3, 2026 08:34
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Sep 3, 2026

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
🔒 Security Review Completed 2026-09-03T08:36:41.569327Z 7832590 Draft marked ready
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

The table was hand-written against the two named cross-variant convenience functions
(docxToPptx/pptxToDocx, odtToOdp/odpToOdt) and never updated once the pathfinder started
generating the full cross-product of same-variant and cross-variant-transform edges, so most
non-diagonal, non-odf cells were wrongly marked unroutable ("-"): every wordprocessing-family
to presentation-family pair (docx/odt/markdown x pptx/odp), every drawing-family to
presentation-family pair (odg/svg x pptx/odp), every bare two-hop PDF pivot between two
layout-capable formats with no bridge shortcut (ods to docx/pptx/odt/odp/odg/svg/markdown),
and every three-hop bridge-plus-pivot route reaching xlsx from a layout-capable format.

Every cell is now derived from resolveCompositionPlan's actual resolved route for each of the
156 ordered pairs among the 13 DocumentFormat members (verified via a throwaway audit script
calling resolveCompositionPlan directly, not hand-reasoned), rating each by the worst-fidelity
hop in its route: same-variant bridge, cross-variant transform, toPdf, or fromPdf, compounding
two chained transforms or two chained PDF legs one severity tier up from the worse individual
leg, matching the convention the table's own pre-existing xlsx-markdown/svg-csv/svg-markdown
cells already used.

Adds rtf's row and column, rated from rtf-codec's own documented Scope (carries
colour/font/size/alignment natively, unlike markdown, but drops superscript/subscript, cell
shading/borders/vertical merge, right-to-left text, and multi-section structure) crossed with
the routes the pathfinder actually resolves for it: rtf-csv and rtf-xlsx stay unroutable (one
hop past the pathfinder's 3-hop cap), everything else routes.

Updates the table's own summary line to 129 of 156 (up from the stale 111 of 132, itself
derived independently of what the table's own cells summed to) and the surrounding prose
describing the same-variant, markdown, and cross-variant-transform bridge families to match.
@Mearman
Mearman force-pushed the docs/documents-js-fidelity-table-audit branch from 7832590 to 6e62ad8 Compare September 3, 2026 08:36
@Mearman
Mearman merged commit 1e707ad into main Sep 3, 2026
16 checks passed
@Mearman
Mearman deleted the docs/documents-js-fidelity-table-audit branch September 3, 2026 08:40
@github-actions

github-actions Bot commented Sep 3, 2026

Copy link
Copy Markdown
Contributor

🎉 This PR is included in version 6.3.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

documents.js README Fidelity table: add rtf, and audit pre-existing drift

1 participant