Publish the measured performance numbers in the README - #481
Merged
Merged
Conversation
The README's first line calls this app fast. #257 turned that adjective into a benchmark, but the numbers landed only in docs/dev/performance.md, which is read a thousand times less often than the front page. A new Performance section prints them: one row per fixture, the first screen, status and the first page of history, with git's own work beside the last and the ratio between them. Why: the block is GENERATED by scripts/bench-report.mjs from the same docs/dev/benchmark.json the doc's tables come from, and test/benchmark.test.ts re-renders it and fails on any disagreement. A hand-typed figure on the front page is the one that stops moving on the next run, and this is the file where nudging one would pay off most. It leads with the bad case rather than burying it: torvalds/linux opens in 15.8 s and ten pages into its history cost 157.67 s, interpolated from the record so that fixing the thing also unwrites the sentence. A further guard fails the build if a measured figure is written by hand in the prose around the block. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
The module header still described the pair it rendered before the README block joined them, and the README's framing promised a git timing column the summary table does not carry — it carries the ratio. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
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.
Part of #257 — the README half. The site half is still deliberately waiting, and
docs/dev/performance.mdnow says why the two differ.What
A
## Performancesection in the README, between "How it compares" and "Features": one row per benchmark fixture, with the first screen, working-tree status, the first page of history and the ratio againstgit's own work.gitNothing was re-measured. The block is rendered from the committed
docs/dev/benchmark.json, which is the same recorddocs/dev/performance.md's tables come from.Why it is generated rather than typed
The README's first line calls this app fast, which makes it the single place where nudging a figure would pay off most — the failure
#257exists to prevent. Soscripts/bench-report.mjsgainedrenderReadme()and a marker pair of its own,pnpm benchnow writes three files instead of two, andtest/benchmark.test.tsre-renders the README block from the record and fails on any disagreement.Four new guards, each proven by planting the violation it describes and confirming it failed alone:
253 ms→153 msby handREADME.mdin thejspath filterThe third is the one worth calling out: the prose around the block is hand-written, and a measured figure copied into it is exactly what stops moving on the next run.
50,000-commitdoes not trip it;253 msdoes.It leads with the bad case
performance.mdsaid publishing 15.8 s fortorvalds/linuxas a selling point was the wrong response to it. That reasoning is about the marketing site and still holds there — but the README already carries "Where we are behind" and a "Status" list of known gaps, so the honest number belongs on it. The paragraph under the table names it outright, and it is interpolated from the record rather than typed, so fixing the log walk also unwrites the sentence.docs/dev/performance.mdis updated to distinguish the two audiences instead of saying "not published yet".Verification
pnpm tsc --noEmit— cleanpnpm test— 4182 tests in 407 files, all passing, run after the last editNo
src/orsrc-tauri/change, so e2e is untouched.🤖 Generated with Claude Code