Skip to content

Update benchmark docs with interactive UX results - #373

Merged
Alek99 merged 1 commit into
mainfrom
agent/update-benchmark-docs
Jul 29, 2026
Merged

Update benchmark docs with interactive UX results#373
Alek99 merged 1 commit into
mainfrom
agent/update-benchmark-docs

Conversation

@Alek99

@Alek99 Alek99 commented Jul 29, 2026

Copy link
Copy Markdown
Member

Summary

  • replace the older launch/static benchmark documentation with the README's 10k–100M interactive UX results
  • update the live benchmark chart, timing and Python-memory tables, methodology, caveats, and reproduction links
  • refresh the homepage benchmark summary and its docs assertion

Why

The README now publishes the interactive browser sweep, but the public docs still described the older launch PNG and first-render baseline. This brings the docs site back in sync with the current benchmark evidence and makes the density-versus-exact comparison explicit.

Impact

Readers now see the current end-to-end interactive results, including failure points, memory measurements, measurement contracts, and environment caveats. The benchmark remains a live XY chart in the docs site.

Validation

  • pytest tests -q — 92 passed, 1 expected xfail
  • Ruff check and format checks
  • codespell
  • repository pre-commit hooks
  • production Reflex build
  • sitemap, Markdown asset, and HTML route validators

Summary by CodeRabbit

  • New Features

    • Added an interactive rendering performance demo covering datasets from 10,000 to 100 million points.
    • Updated documentation with live interactive benchmark results, timing comparisons, memory usage, and reproducibility guidance.
    • Documented automatic switching to a density view for larger datasets while preserving exact-point inspection when zoomed in.
  • Documentation

    • Replaced launch benchmark content with interactive UX benchmark guidance and updated charts.
    • Refined navigation and call-to-action presentation in the documentation.

@coderabbitai

coderabbitai Bot commented Jul 29, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 35689041-69a3-47fa-b1e6-7f5e3374ecd4

📥 Commits

Reviewing files that changed from the base of the PR and between fc09e67 and e9c22a0.

📒 Files selected for processing (4)
  • docs/app/tests/test_docs_site.py
  • docs/app/xy_docs/demos/benchmark_charts.py
  • docs/index.md
  • docs/overview/benchmarks.md

📝 Walkthrough

Walkthrough

Changes

The PR replaces launch-benchmark documentation and charts with a live interactive UX benchmark covering render time, memory, density mode, failure markers, and reproduction guidance.

Interactive benchmark

Layer / File(s) Summary
Interactive render-time chart
docs/app/xy_docs/demos/benchmark_charts.py
Replaces the previous benchmark demos with interactive_ux_demo(), updated series data, render-time annotations, legend styling, and exports.
Interactive benchmark methodology
docs/overview/benchmarks.md
Documents the 10k–100M sweep, timing and memory tables, benchmark criteria, comparison scope, recorded evidence, and reproduction commands.
Documentation site integration
docs/index.md, docs/app/tests/test_docs_site.py
Updates the Why XY narrative, embeds the interactive demo, revises density-mode wording and link formatting, and aligns the site assertion.

Estimated code review effort: 3 (Moderate) | ~25 minutes

Suggested reviewers: carlosabadia

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch agent/update-benchmark-docs

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

@Alek99
Alek99 marked this pull request as ready for review July 29, 2026 00:43
@Alek99
Alek99 merged commit 22ba6e0 into main Jul 29, 2026
9 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