Repository navigation
docs: shorten the entrance, fold the negative results - #24
Merged
Merged
Conversation
The README had grown to 586 lines, and a reader had to scroll past the format table and the recipes before reaching anything they could run. Nothing is removed here — the long analyses move behind <details>, so the page reads short and still answers "show me the numbers" in one click. - move "Try it in one minute" (the public-domain, end-to-end example) directly after Install, above Use - fold the deep dives behind <details>, each with its conclusion left visible: format/TTML internals, the AMLL recipe notes, model x pairing, the Vilm head-to-head, the stable-ts comparison - turn "Known limits" from four long bullets into headed subsections, each leading with the limitation and the workaround, with the measurements folded Visible length drops to 368 lines with 286 folded. Verified: every numeric token in the old README still appears (no measurement dropped), the three internal anchors still resolve, 59 tests pass.
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.
The README had grown to 586 lines, and a reader had to scroll past the format table and the recipes before reaching anything they could run.
Nothing is removed. The long analyses move behind
<details>, so the page reads short and still answers "show me the numbers" in one click. The negative results are the evidence that the claims were tested — folding them is fine, deleting them is not.What moved
Verification
<details>)#known-limits,#against-vilm…,#coming-from-stable-ts)<details>(blank line after<summary>)The numeric-token check is the one that matters: re-wrapping paragraphs makes a line-level diff unreadable, so preservation was verified at the level of the claims rather than the lines.
🤖 Generated with Claude Code