Skip to content

docs: make benchmark results understandable at a glance - #54

Merged
0monish merged 3 commits into
mainfrom
docs/evidence-backed-benchmark-highlights-20260922
Sep 22, 2026
Merged

0monish merged 3 commits into
mainfrom
docs/evidence-backed-benchmark-highlights-20260922

Conversation

@0monish

@0monish 0monish commented Sep 22, 2026 •

Copy link
Copy Markdown
Member

Turns the benchmark README into a public-facing evidence summary without changing any benchmark data.

  • leads with the strongest current signals: paired KELD-vs-Tauri host memory, KELD-vs-Electron main-process RSS, and Windows host executable size
  • explains the current host-size result precisely: 484,864 B for KELD vs 8,634,880 B for Tauri (~94.4% smaller by bytes; Tauri is ~17.8x as large)
  • explains in plain English what each metric actually represents
  • adds a broader same-machine Windows main-process RSS context table for KELD, Neutralino, Tauri, Wails, Electron, and NW.js
  • keeps first-paint and total-RSS non-wins visible
  • explicitly labels the numbers as initial, metric-specific evidence rather than an overall framework ranking

Raw results, detailed measurements, and the harness contract remain the source of truth.

@coderabbitai

coderabbitai Bot commented Sep 22, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: 53a96d95-2617-40f5-9ff1-9d3353f9a239

📥 Commits

Reviewing files that changed from the base of the PR and between 3e033fe and c2c899d.

📒 Files selected for processing (1)
  • README.md

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

The README adds evidence-backed Keld benchmark comparisons for selected Windows metrics. It also documents limits for framework-wide, Linux startup, cross-session, and cross-lane claims.

Changes

Benchmark documentation

Layer / File(s) Summary
Evidence-backed advantages section
README.md
Documents metric-specific Windows comparisons for memory, first paint, RSS, executable size, and host size. It also records scope qualifications and matching-session and matching-lane requirements.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~3 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to c2c89

This PR adds scoped benchmark documentation without changing runtime behavior or benchmark data, so it is mergeable with normal documentation checks.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the README documentation change. It matches the objective of making benchmark results easier to understand at a glance.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@0monish 0monish changed the title docs: surface evidence-backed benchmark advantages docs: make benchmark results understandable at a glance Sep 22, 2026
@0monish
0monish merged commit d840fd5 into main Sep 22, 2026
8 checks passed
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