Skip to content

docs: shorten the entrance, fold the negative results - #24

Merged
ijuinryukichi merged 1 commit into
mainfrom
docs/shorten-readme-entrance
Jul 25, 2026
Merged

ijuinryukichi merged 1 commit into
mainfrom
docs/shorten-readme-entrance

Conversation

@ijuinryukichi

Copy link
Copy Markdown
Owner

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

  • "Try it in one minute" (the public-domain, end-to-end example) now sits directly after Install, above Use. Install → run something → then learn the options.
  • Deep dives folded, each with its conclusion left visible above the fold: format/TTML internals, the AMLL recipe notes, model × pairing, the Vilm head-to-head, the stable-ts comparison.
  • "Known limits" goes from four long bullets to headed subsections, each leading with the limitation and the workaround, measurements folded.

Verification

check result
visible length (outside <details>) 586 → 368 lines, 286 folded
every numeric token from the old README still present 0 dropped (counted per-token, none decreased)
internal anchors (#known-limits, #against-vilm…, #coming-from-stable-ts) all 3 resolve
markdown inside <details> (blank line after <summary>) 8/8 blocks well-formed
tests 59 passed

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

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.
@ijuinryukichi
ijuinryukichi merged commit 2b6ea89 into main Jul 25, 2026
3 checks passed
@ijuinryukichi
ijuinryukichi deleted the docs/shorten-readme-entrance branch July 25, 2026 23:30
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