Tighten the README and cut marketing filler by Alek99 · Pull Request #346 · reflex-dev/xy

Alek99 · 2026-07-27T19:01:32Z

Makes the README read less like generated copy and about a third shorter. Prose goes from 1145 to 761 words; no code samples, images, or benchmark numbers change.

Copy

New tagline: XY is a fast, interactive, customizable Python charting library for the web, notebooks, and static exports. Replaces the three-clause "Small data should be effortless / Large data should stay interactive / Neither should limit the design."
Intro is now two plain paragraphs instead of a paragraph plus a six-item Highlights list.
Cut the aphorisms: "The data size changes; the chart model does not.", "Performance is not a preset.", "That baseline is one proof point, not the finish line."
Cut the paragraph claiming XY will "outperform every competing charting library across small-data startup, massive-data rendering, interaction, memory, payload and export size, multi-chart applications, chart breadth, and customization."
Dropped What you can build today (restated Highlights) and Documentation.
Example gallery labels now say what the charts are: "cosmic observatory" → "HR diagram", "genomic atlas" → "allele frequency", "biobank editorial" → "Manhattan plot", "signal-lab oscilloscope" → "GW150914 strain", "night cartography" → "taxi pickup density".
All em dashes are gone; the roadmap list uses colons, matching the Customize bullets.

Structure

Is XY right for me? → Installation → Getting started → Customize every layer → Benchmarks → Reflex → Examples → How it works → Roadmap. Examples moved above How it works.

Follow-ups, not in this PR

pyproject.toml sets readme = "README.md", so this file is the PyPI long description, where relative links 404. The styling guide and capability matrix now use absolute GitHub URLs; 20 other links and all 4 images still don't. Images need raw.githubusercontent.com to render there.
spec/api/api-examples.md and CHANGELOG.md lost their only link when the Documentation section went. Worth re-homing if they should stay discoverable.
16–18× in Benchmarks keeps an en dash as a numeric range.

Summary by CodeRabbit

Documentation
- Refreshed the README marketing and introductory copy to emphasize XY as a fast, interactive, customizable charting library with pan/zoom, hover, and selection.
- Rewrote “Getting started” and tightened “Customize every layer” into a compact overview of Marks/Guides/Interaction/Layout, including a brief compatibility note.
- Condensed “Benchmarks” and “Embed XY in a Reflex app” while keeping the benchmark/adapter narrative.
- Updated “Examples” and “How it works,” including clearer notebook data-source behavior and the core performance approach.
- Reworded and reorganized the Roadmap content with a new zoom/overview framing.

Rewrite the top-of-file copy: a one-line tagline, the intro folded into two short paragraphs, and the Highlights bullet list dropped. Trim the benchmark, Reflex, and how-it-works sections, remove the "What you can build today" section that restated Highlights, and rename the example-gallery labels to what each chart actually is ("cosmic observatory" -> "HR diagram"). Also move Examples above How it works, drop the Documentation section, replace the em dashes in the roadmap list with colons, and point the styling guide and capability matrix at absolute GitHub URLs so they resolve on PyPI. Prose drops from 1145 to 761 words. No code samples, images, or benchmark numbers change.

coderabbitai · 2026-07-27T19:01:53Z

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 7572c699-3aea-4693-831c-d048d7b3a341

📥 Commits

Reviewing files that changed from the base of the PR and between 89cc906 and 9b77762.

📒 Files selected for processing (1)

README.md

📝 Walkthrough

Walkthrough

README content is condensed and reorganized across onboarding, customization, Reflex integration, examples, architecture, and roadmap sections. No exported or public declarations are changed.

Changes

README Documentation Refresh

Layer / File(s)	Summary
Positioning and onboarding copy `README.md`	The introduction, audience guidance, getting-started text, and large-dataset description are rewritten in a more concise form.
Customization and Reflex integration `README.md`	Customization guidance now uses compatibility notes and capability bullets; benchmark and Reflex embedding content are condensed.
Examples, architecture, and roadmap `README.md`	Examples, linked-source notebook guidance, storage and rendering explanations, and roadmap content are refreshed.

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

Possibly related PRs

reflex-dev/xy#296: Overlaps with the README Examples and linked-public-data documentation.
reflex-dev/xy#297: Overlaps with the README Getting started and Benchmarks documentation.
reflex-dev/xy#300: Overlaps with onboarding, Reflex adapter, and Roadmap content.

Suggested reviewers: palashawasthi05, farhanaliraza

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately summarizes the README cleanup and removal of marketing-heavy copy.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch alek/readme-tighten

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

Drop the centered bold wrapper so the first sentence is left-aligned prose like the rest of the README.

coderabbitai

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 115-116: Update the README references covered by this change,
including the compatibility guide, example guide, gallery images, and notebooks,
to use absolute GitHub repository URLs instead of relative paths so they resolve
correctly outside GitHub.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

Push a commit to this branch (recommended)
Create a new PR with the fixes

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 8f27f153-c61f-4905-bbf3-a9dc3c17c52d

📥 Commits

Reviewing files that changed from the base of the PR and between 9fdc236 and ab71e93.

📒 Files selected for processing (1)

README.md

coderabbitai · 2026-07-27T19:04:56Z

+See the [compatibility guide](spec/matplotlib/compat.md); not all charts and
+functionality are supported yet.


📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Make changed repository links portable outside GitHub.

The compatibility guide, example guide, gallery images, and notebooks still use relative paths. If this README is rendered on PyPI, these links/assets may resolve against pypi.org and break. Convert the changed repository references to absolute GitHub URLs, or verify PyPI rendering before merge.

This follows the PR objective that PyPI-relative links and image URLs remain follow-up items.

Also applies to: 219-226

🤖 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 115 - 116, Update the README references covered by this change, including the compatibility guide, example guide, gallery images, and notebooks, to use absolute GitHub repository URLs instead of relative paths so they resolve correctly outside GitHub.

codspeed-hq · 2026-07-27T19:08:42Z

Merging this PR will not alter performance

✅ 103 untouched benchmarks
⏩ 2 skipped benchmarks¹

_{Comparing alek/readme-tighten (9b77762) with main (4e11a66)}

2 benchmarks were skipped, so the baseline results were used instead. If they were deleted from the codebase, click here and archive them to remove them from the performance reports. ↩

Make the opening line regular body text

89cc906

Drop the centered bold wrapper so the first sentence is left-aligned prose like the rest of the README.

coderabbitai Bot reviewed Jul 27, 2026

View reviewed changes

masenf previously approved these changes Jul 27, 2026

View reviewed changes

Rewrite the intro copy

9b77762

Alek99 dismissed masenf’s stale review via 9b77762 July 27, 2026 20:23

Alek99 merged commit 81e36b9 into main Jul 27, 2026
19 of 20 checks passed

This was referenced Jul 28, 2026

Interactive-chart UX benchmark harness #357

Merged

docs: add alpha callout to README #361

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Tighten the README and cut marketing filler - #346

Tighten the README and cut marketing filler#346
Alek99 merged 3 commits into
mainfrom
alek/readme-tighten

Alek99 commented Jul 27, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

coderabbitai Bot commented Jul 27, 2026 •

edited

Loading

Walkthrough

Changes

Uh oh!

coderabbitai Bot left a comment

Uh oh!

coderabbitai Bot Jul 27, 2026

Uh oh!

codspeed-hq Bot commented Jul 27, 2026 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

		See the [compatibility guide](spec/matplotlib/compat.md); not all charts and
		functionality are supported yet.

Uh oh!

Conversation

Alek99 commented Jul 27, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Copy

Structure

Follow-ups, not in this PR

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented Jul 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

coderabbitai Bot Jul 27, 2026

Choose a reason for hiding this comment

Uh oh!

codspeed-hq Bot commented Jul 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Merging this PR will not alter performance

Footnotes

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Alek99 commented Jul 27, 2026 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Jul 27, 2026 •

edited

Loading

codspeed-hq Bot commented Jul 27, 2026 •

edited

Loading