Refresh README for adoption by Alek99 · Pull Request #230 · reflex-dev/xy

Alek99 · 2026-07-23T18:25:59Z

Summary

add transparent XY binned-scatter artwork at the top of the README
refresh positioning, installation, and docs links for Reflex-hosted docs
add a positive Is xy for me? section and clarify current capabilities
update the “How it works” architecture diagram to reflect the shipped data flow and representation bounds
remove the License and contributor-setup sections from the README

Validation

rendered the artwork from the documentation’s canonical XY demo
compiled the Reflex documentation app in dry mode
ran git diff --check and the repository claim guardrails

greptile-apps · 2026-07-23T18:27:54Z

Greptile Summary

This PR refreshes the README for public adoption. The main changes are:

Adds a new README hero image and updates the docs badge to reflex.dev.
Reworks positioning, installation, benchmarks, styling, Reflex embedding, architecture, and current-capabilities sections.
Adds the new spec/assets/xy-sdf-binned-scatter.png artwork.
Removes the README-specific sdist content check and its regression test.

Confidence Score: 4/5

Mostly safe to merge; the changed behavior is limited to documentation and release-verification coverage.

README and asset changes are consistent with the new public-facing content. The removed README sdist guard is the only notable risk and was already raised in the PR discussion.

scripts/verify_sdist.py and tests/test_verify_sdist.py.

T-Rex Logs

What T-Rex did

The docs adoption compile run completed, capturing the selected compile command, Reflex initialization, warnings, full build, app startup, and the generated XY asset listing.
The git diff checks were executed and exited with code 0, indicating no issues detected in the changes.
The claim guardrails were validated and the optional verifier unit tests ran, both finishing with exit code 0.

_{Ran code and verified through T-Rex}

Important Files Changed

Filename	Overview
README.md	Refreshes public README positioning, examples, benchmarks, Reflex embedding guidance, and documentation links.
scripts/verify_sdist.py	Removes the README content marker check from sdist verification.
spec/assets/xy-sdf-binned-scatter.png	Adds the README hero artwork asset referenced by the new image tag.
tests/test_verify_sdist.py	Updates the README fixture and removes the stale README rejection regression test.

_{Reviews (8): Last reviewed commit: "Remove README content verification" | Re-trigger Greptile}

codspeed-hq · 2026-07-23T18:34:56Z

Merging this PR will not alter performance

✅ 102 untouched benchmarks
⏩ 1 skipped benchmark¹

_{Comparing agent/refresh-readme (3f997b6) with main (e8d21a9)}

1 benchmark was skipped, so the baseline result was used instead. If it was deleted from the codebase, click here and archive it to remove it from the performance reports. ↩

tgberkeley · 2026-07-23T20:25:10Z

+The chart keeps its built-in hover, pan, and zoom behavior. For charts driven
+by Reflex state, events, or live streams, see the
+[Reflex integration guide](https://reflex.dev/docs/xy/integrations/reflex/)
+and the [runnable example app](examples/reflex/).


This link goes nowhere

Most conflicts were squash artifacts: main's #226 is the same mean-color density work this branch already carries as commits (main's conflicted spec/client/kernel/test files are byte-identical to this branch's pre-work state), so those resolve to this branch's extended versions. Real incoming changes kept from main: - src/tiles.rs: separable area-weighted compose (#228) — taken wholesale (this branch made no tiles.rs changes beyond the shared #226 content); kernels.rs/lib.rs wasm panic-abort hardening (#200) auto-merged. - README.md: the #230 adoption refresh replaced the inline benchmark table (this branch's only README edit) with links to the launch report, so main's version stands; the 0.1.0 launch-baseline report keeps its historical "density + sample" labels — it records what that release did. Verified on the merged tree: cargo tests, ABI smoke, render smoke, and the full pytest+benchmarks suite — the only failures are 21 doc-contract tests (test_docs_examples/test_verify_local/pyplot perf guardrail) that fail identically on pristine origin/main in this environment: the #230 README rewrite removed maintainer-shortcut text its guardrail tests still assert. Pre-existing on main, not introduced here.

* Remove tests that assert on markdown file content CI was coupled to prose in README.md, CONTRIBUTING.md, SECURITY.md, and the spec/docs markdown trees: a docs refresh (#230) that reworded the README turned every downstream branch red without any code change. Drop the markdown-content tests so doc edits can no longer break CI. - Delete tests/test_docs_examples.py wholesale (every test read a repo .md file — README/API/spec prose and executable code fences). - Strip the markdown-reading test functions from the mixed suites, keeping their non-markdown coverage: - test_verify_local.py: drop the 10 'docs name <shortcut>' tests and the README/CONTRIBUTING assertion in the setup test (the Makefile setup-recipe check stays); remove the now-unused SPEC_DOCS constant. - test_benchmark_environment.py: drop the benchmarks/README.md runbook reads, keeping the pyproject/CI/script assertions. - test_claim_guardrails.py: drop the two tests that scan the real repo docs; the 12 synthetic-fixture scanner tests stay. - test_lod.py / test_check_regressions.py / test_static_client_security.py / test_type_surface.py: drop the single doc-content test/assertion in each (plus a now-unused import). - Update the verify_local.py 'examples'/'security_export' gates and the verify_sdist.py REQUIRED_FILES manifest to stop referencing the deleted file. Synthetic-fixture tests that write their own tmp_path markdown to exercise script logic are kept: they are not coupled to repo docs. * Update verify-gate meta-tests for the removed docs-example file The markdown-test removal dropped tests/test_docs_examples.py and the verify_local.py/verify_sdist.py references to it, but three meta-tests still asserted the old gate/manifest shape and turned CI red: - test_example_checks_are_known_as_targeted_gate: the examples gate now runs only test_example_apps.py. - test_dry_run_includes_examples_gate: drop the test_docs_examples.py dry-run assertion. - test_verify_sdist_rejects_missing_docs_example_guard: obsolete once the file left REQUIRED_FILES; the example-app guard already covers sdist test inclusion. Removed. Also repoint the wheel sdist-only-files parametrization from the deleted test_docs_examples.py to an existing tests/ path (behavior unchanged; it matches on the tests/ prefix). Full suite: 2106 passed, 0 failed.

Refresh README for adoption

376dc68

Add xy logo to README

18594de

Alek99 added 10 commits July 23, 2026 11:35

Add XY chart grid to README

1c266e0

Remove redundant README title

3251300

Use transparent XY chart artwork

7207b27

Remove README contributor setup

e26d3cd

Clarify README architecture diagram

eee37e4

Remove README benchmark comparison

b12b3c5

Simplify README architecture diagram

77066e2

Add Reflex embedding example

1745999

Restore README benchmark graph

4549d99

Move benchmarks below audience section

db8c3ed

Alek99 marked this pull request as ready for review July 23, 2026 19:02

Alek99 requested a review from tgberkeley July 23, 2026 19:04

Alek99 added 9 commits July 23, 2026 12:06

Remove README marker check from sdist verification

e15a158

Simplify README introduction

7731211

Remove Marimo from README

7e26b82

Tighten README highlights

e2e69fa

Rename declarative interface highlight

0644344

Shorten documentation link label

c44e606

Capitalize XY brand in README

61ed551

Add README styling example

067b11a

Combine styling guide introduction

526a2d3

tgberkeley reviewed Jul 23, 2026

View reviewed changes

small readme fix

8e086d9

greptile-apps Bot reviewed Jul 23, 2026

View reviewed changes

Comment thread scripts/verify_sdist.py

tgberkeley and others added 2 commits July 23, 2026 13:35

small fix

203d686

Verify sdist README matches source

ad5de08

Remove README content verification

3f997b6

Alek99 merged commit b6ab496 into main Jul 23, 2026
21 of 23 checks passed

This was referenced Jul 23, 2026

Decouple CI tests from README #236

Merged

Grey, persistent box/lasso/x-range/y-range selections #238

Merged

Remove tests that assert on markdown file content #239

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Refresh README for adoption#230

Refresh README for adoption#230
Alek99 merged 25 commits into
mainfrom
agent/refresh-readme

Alek99 commented Jul 23, 2026 •

edited

Loading

Uh oh!

greptile-apps Bot commented Jul 23, 2026 •

edited

Loading

T-Rex Logs

Uh oh!

codspeed-hq Bot commented Jul 23, 2026 •

edited

Loading

Uh oh!

tgberkeley Jul 23, 2026

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

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

Uh oh!

Summary

Validation

Uh oh!

greptile-apps Bot commented Jul 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Greptile Summary

Confidence Score: 4/5

T-Rex Logs

Important Files Changed

Uh oh!

codspeed-hq Bot commented Jul 23, 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!

tgberkeley Jul 23, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Alek99 commented Jul 23, 2026 •

edited

Loading

greptile-apps Bot commented Jul 23, 2026 •

edited

Loading

codspeed-hq Bot commented Jul 23, 2026 •

edited

Loading