Repository navigation
docs: reconcile README, CHANGELOG and ROADMAP with the binary - #40
Merged
Merged
Conversation
The README described a tool three milestones behind the one it ships next to, and in two places contradicted itself on the same page. Sample output. The audit and repair transcripts predated both the `fonts NOT RUN` line and `--strip-tatweel`, so they showed a header the binary no longer prints — while the prose below promised the very line the sample omitted. The `explain` transcript stopped four lines in, hiding the two resolved visual orders, and padded `logical text` by one space more than the renderer does. All three now match `render.rs`; the `explain` block is byte-identical to the real output. Status. The section led with "audit only, PPTX only" six lines under an intro claiming four formats and three writers. Since nothing is published, a reader builds from source and gets everything — so the section now describes `main` and names the milestones that are not done. The Arabic half had never been updated past M0 and said PowerPoint only; it now carries the same claims as the English. Tags. There are none — local or remote — so CHANGELOG's compare and release links were both dead, and the roadmap's `✅ shipped` marker claimed releases for v0.1.0 through v0.6.0 that were never cut. The marker now reads "landed on `main`", the links point at the branch, and both files say plainly that the version numbers are plans and that tagging is M7. Docs only; no code changed.
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
1 participant
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.
Docs only. No code changed.
The README described a tool three milestones behind the one it ships next to, and contradicted itself twice on the same page. Every claim below was checked by running the binary.
Sample output no longer matches the renderer
fonts NOT RUNline — while the prose 100 lines further down promised that exact line exists. Added.--strip-tatweel(M4.4), so its settings line was missing a field the binary prints. It was also missingfonts NOT RUN. Both added.logical textone space wider thanrender.rsdoes. Now byte-identical to real output, verified by diff. Added a note on why those lines are codepoints rather than glyphs.Status contradicted the intro
The section led with "v0.1 — audit only, PPTX only" six lines below an intro claiming four formats and three writers. Since nothing is published, a reader builds from source and gets everything — so Status now describes
mainand names what is not done (M6, M7).The Arabic half had never been updated past M0: it still said PowerPoint only, audit only. It now carries the same claims as the English.
No tags exist
git tag -landgit ls-remote --tagsboth return nothing, which broke two more things:compare/v0.1.0...HEADandreleases/tag/v0.1.0links were dead. They now point atmain, with a line saying tagging is M7.✅ shippedmarker would have claimed releases for v0.1.0–v0.6.0 that were never cut. It now reads "landed onmain", and a note up top says the version numbers are plans.CHANGELOG's
[Unreleased]blurb still read "Working towards byte-preserving repair for PPTX" — done four milestones ago. It now summarises M1–M5 and points at M6.