Open the README with a hello-world and add a chart roadmap - #300
Conversation
Four onboarding fixes to the README: - Getting started opened with the 100M-point density demo. Impressive, but intimidating as the first thing a reader copies. A three-line line chart built from plain Python lists now leads, and the density demo follows as "the same API scales". - The Reflex section jumped straight to `import reflex_xy` while Installation only mentioned `pip install xy`. Since reflex-xy is a separate distribution, following that section verbatim ended in ModuleNotFoundError. Added the install block. - Cut the density explanation from eleven lines to two sentences, keeping the benchmarked numbers unchanged. - Added a Roadmap section listing the chart families queued next, pulled from spec/api/chart-roadmap.md in its own priority order, with each family's real status (planned, prototyped, or promoting out of xy.pyplot) and a link to the full ranked backlog.
|
Warning Review limit reached
Next review available in: 31 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. 📝 WalkthroughWalkthroughThe README adds a basic chart introduction and example, clarifies density rendering and export behavior, documents ChangesREADME documentation
Estimated code review effort: 1 (Trivial) | ~5 minutes Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.md`:
- Around line 102-104: Update the density-performance paragraph in README.md to
identify the dataset, execution mode, and environment used for the figures.
Verify that the 0.2 s, 1.03 MB, and 189,319 values match benchmark outputs from
scripts/bench.py, and revise the claims to use those benchmark-sourced values
rather than undocumented unconditional behavior.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
| Past a threshold the scatter becomes a density surface — 100M points compose | ||
| in 0.2 s into a 1.03 MB payload sized by the screen, not by `n` — and zooming | ||
| into a sparse region drills back to the real rows, 189,319 at the depth shown. |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Scope the density performance figures and source them from the benchmark.
These values are presented as unconditional behavior. Add the matching dataset, execution mode, and environment, and verify that 0.2 s, 1.03 MB, and 189,319 come from scripts/bench.py rather than being manually maintained.
As per coding guidelines, README performance claims must be mode-scoped and benchmarked, and README numbers must come from scripts/bench.py.
#!/bin/bash
# Verify the documented figures and their benchmark provenance.
rg -n "0\.2|1\.03|189,319|100[_ ]?million|density" README.md scripts/bench.py🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@README.md` around lines 102 - 104, Update the density-performance paragraph
in README.md to identify the dataset, execution mode, and environment used for
the figures. Verify that the 0.2 s, 1.03 MB, and 189,319 values match benchmark
outputs from scripts/bench.py, and revise the claims to use those
benchmark-sourced values rather than undocumented unconditional behavior.
Source: Coding guidelines
Merging this PR will not alter performance
Comparing 
Footnotes
|
1 participant
Four onboarding fixes to the top-level README.
Lead with a hello-world
Getting started opened with the 100M-point density demo — a great showcase, but
intimidating as the first thing a reader copies. A three-line line chart built
from plain Python lists now leads, and the density demo follows as "the same API
scales".
Verified: ran this snippet verbatim against this branch and rendered the
to_htmlexport in a browser — real line, axes, grid.Add the missing
reflex-xyinstall step"Embed XY in a Reflex app" jumped straight to
import reflex_xywhileInstallation only listed
pip install xy. Sincereflex-xyis a separatedistribution, following that section verbatim ended in
ModuleNotFoundError.Added a pip/uv install block matching the Installation section's shape.
Trim the density explanation
Eleven lines down to two sentences. The benchmarked numbers (0.2 s, 1.03 MB,
189,319 rows) are carried over unchanged. Two minor sentences were dropped: "the
same chart exports unchanged" (the code block's
to_html/to_png/to_svgcomments already say it) and the note that the dark GIF is the same chart with
colormap="magma".Add a Roadmap section
A short list of the chart families queued next, pulled from
spec/api/chart-roadmap.mdin its own priorityorder — categorical distributions and regression diagnostics next, pie/donut
promoting out of
xy.pyplot, candlestick and the finance overlays stillprototyped. Ranks and per-family status prose are deliberately left in the
roadmap doc so the README does not drift as that doc is reordered; the section
links out to it. Closes with a pointer to open an issue for a chart or feature
that isn't listed.
Checks
pre-commit run --all-files,ruff check ., andruff format --check .allpass. README-only change; no test or lint hook reads the root README (codespell
is scoped to
docs/).Summary by CodeRabbit