Rewrite the README - #9
Merged
Merged
Conversation
Shorter and easier to scan: 357 lines to 218. A centred header with jump links, the example first, then install, commands, languages, numbers. The example is now real output rather than a curated one — `orvix map` at its default budget prints that parser.ts block, and the who-calls lines are verbatim. The old header claimed line numbers the code no longer had. `orvix show parse` was offered as proof that bare names work; it actually matches three symbols in this repository. Replaced with one that resolves, and the ambiguous case is described instead of hidden. Every figure re-measured in one sitting rather than carried over: 405 symbols, 1 201 edges, ~2,032 and ~35,199 for the two measure rows, 55.6/27.2/82.9 ms for latency, the scale table, 395 tests. The latency numbers are higher than the previous README's because the machine was busier, which is what the caveat beside them already said would happen. Dropped: the per-command prose that repeated the table, and the longer retellings of the hook design. Kept: what the call graph cannot see, how ids behave, and the paragraph explaining that these are per-operation numbers — that one is the reason to trust the rest. Co-Authored-By: Claude Opus 5 <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
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.
357 lines → 218. Same substance, easier to scan: a centred header with jump links, the example first, then install, commands, languages, numbers.
Corrected while rewriting
CallGraph :20andbuildCallGraph :62; the real lines are:24and:84, and the caller count had moved from 5 to 6. The example is now genuine output —orvix mapat its default budget really does print thatparser.tsblock, and thewho-callslines are verbatim.orvix show parsewas offered as proof that bare names work. In this repository it matches three symbols. Replaced with one that resolves, and the ambiguous case is now described rather than hidden.Re-measured, all in one sitting
measurebenchscaletestThe latency figures are higher than the previous README's because the machine was busier — which is exactly what the caveat printed beside them says will happen. Left as measured rather than cherry-picked from a quieter moment.
Cut
The per-command prose that repeated the commands table, and the longer retellings of the hook design.
Kept
What the call graph cannot see (including string-dispatched boundaries), how ids behave across edits, and the paragraph explaining that these are per-operation and not per-session numbers. That last one is the reason to trust the rest of them.
Docs only — no code touched. 395 tests still pass.