Repository navigation
docs: remove stale 2.0.0 benchmark snapshot from llms.txt and README - #27
Conversation
The quoted ratios describe the 2.0.0 release (README snapshot dated 2026-10-31, same as CHANGELOG) while version.rb is 2.1.0; AGENTS.md's docs rule forbids hardcoded benchmark numbers. Replaced the snapshot tables with pointers to the CI benchmark workflow (.github/workflows/ benchmark.yml) and `bundle exec rake bench`, kept the code-level "How it is fast" claims, left CHANGELOG.md's dated release notes alone. Dz-Task-Id: tsk_1e0d885c9b903cf9f46031138834403b
Benchmarks: aarch64 (linux)
escape_bench (C ext) · peak RSS 120 MB
escape_bench (pure Ruby) · peak RSS 150 MB
render_bench (C ext) · peak RSS 131 MB
render_bench (pure Ruby) · peak RSS 131 MB
tag_bench (C ext) · peak RSS 39 MB
tag_bench (pure Ruby) · peak RSS 26 MB
Rails request (C ext) · peak RSS 243 MB
|
Benchmarks: x86_64 (linux)
escape_bench (C ext) · peak RSS 120 MB
escape_bench (pure Ruby) · peak RSS 146 MB
render_bench (C ext) · peak RSS 132 MB
render_bench (pure Ruby) · peak RSS 132 MB
tag_bench (C ext) · peak RSS 39 MB
tag_bench (pure Ruby) · peak RSS 27 MB
Rails request (C ext) · peak RSS 232 MB
|
✅ Reviewed — nothing blocking0 actionable comment(s) · grounded on your code ⏱ 27s wall clock · 🤖 developerz.ai — automated review, running on your model and your box. |
There was a problem hiding this comment.
Review summary — 2 file(s), 0 finding(s).
Docs-only edit removing stale 2.0.0 benchmark figures from README and llms.txt, replaced by pointers to CI benchmarks and rake bench; the shown files match the acceptance criteria and no contradictions remain.
- test files were not shown to the reviewer — this diff touched no path recognised as a test, so no assertion was available to read the change against
🤖 developerz.ai review — automated, running on your model and your box. What is this? · Reviewed by router/glm-5.3-flash — 16.3k in / 119 out over 1 call, on your flat-rate plan: no per-token charge (~<$0.01 at list price).
What
The quoted ratios describe the 2.0.0 release (README snapshot dated
2026-10-31, same as CHANGELOG) while version.rb is 2.1.0; AGENTS.md's
docs rule forbids hardcoded benchmark numbers. Replaced the snapshot
tables with pointers to the CI benchmark workflow (.github/workflows/
benchmark.yml) and
bundle exec rake bench, kept the code-level"How it is fast" claims, left CHANGELOG.md's dated release notes alone.
Acceptance
bundle exec rake benchas the source of truth: README keeps its .github/workflows/benchmark.yml link, llms.txt points at CI + README PerformanceChanges
llms.txt(edit) — Line 3 intro blockquote: delete the stale 'Performance at 2.0.0: ... 1.35x ... 2.4-16x ... require costs about 0.4 MB' sentence; replace with one pointer sentence: benchmarks run in CI on every push/PR and README "Performance" holds the current numbers; run locally withbundle exec rake bench. Keep all other lines byte-identical (file is 132 lines).README.md(edit) — Line 23 'Why ruby2html' bullet: drop hardcoded ratios (1.35x Erubi, 2.4-16x Phlex, 40-90% allocations); keep 'Fastest Ruby HTML renderer we've measured' and point at #performance. Line 24: drop 'require costs about 0.4 MB and 19 ms' clause. Performance section: keep intro paragraph (line 199, already links .github/workflows/benchmark.yml and rake bench); delete the '### Snapshot at 2.0.0 release (2026-10-31)' subsection (lines 201-238: page-render table, Rails-request table, 5.9x escaping line, footprint table, Phlex footnote) and replace with a short 'What is measured' list naming b [trimmed]Verification
./bin/checkpassed (exit 0) in 26s.What the editors ran to see the change working, and what they saw:
grep README.md for '2\.0\.0|1\.35x|2\.4.16x|0\.4 MB|Snapshot|19 ms|2026-10-31'(docs): 0 hits — no stale figures or snapshot section remain in README.mdgrep llms.txt for '2\.0\.0|1\.35x|0\.4 MB'(docs): 0 hits; line 3 now reads "Performance: benchmarks run in CI on every push and pull request, and README "Performance" holds the current numbers; run them locally withbundle exec rake bench"code_read README.md:20-29 and 196-211 after the edits(docs): Why bullet keeps 'Fastest Ruby HTML renderer we've measured' + Performance link, require-cost clause gone; Performance section = intro (benchmark.yml link) + '### What is measured' list of bench/render_bench.rb, bench/tag_bench.rb, bench/escape_bench.rb, spec/benchmarks/requests_spec.rb + 'How it is fast' list intact; single blank linescode_glob bench/*.rb and code_read of each script's header + spec/benchmarks/requests_spec.rb(docs): all four cited benchmark paths exist and each bullet's description matches the script's own header comments🤖 Opened by developerz.ai for task
tsk_1e0d885c9b903cf9f46031138834403bon sebyx07/ruby2html.Raised automatically by the
raw_task_triagelane.