Skip to content

Set XY's competitive product north star - #313

Merged
Alek99 merged 3 commits into
mainfrom
agent/readme-every-chart-every-scale
Jul 26, 2026
Merged

Set XY's competitive product north star#313
Alek99 merged 3 commits into
mainfrom
agent/readme-every-chart-every-scale

Conversation

@Alek99

@Alek99 Alek99 commented Jul 26, 2026

Copy link
Copy Markdown
Member

Summary

  • Position XY around an explicit ambition to become the fastest and most customizable Python charting library across every chart family and every data scale, from a handful of values to billions of rows.
  • Make that ambition a repository-wide product north star for agents and contributors: every competitor lead is a product gap, backed by reproducible benchmarks, raw results, capability coverage, and visual examples.
  • Expand the roadmap beyond a 2D-only destination to include geographic, 3D, and volume visualization.
  • Remove the public-claim guardrail checker, tests, CI wiring, Make targets, and wording-policy sections.

Why

The existing README primarily positioned XY as a large-data 2D specialist. This change makes the intended destination unmistakable: one charting system for ordinary and massive datasets, any chart family, leading performance, and complete design control. The benchmark program becomes the evidence system for proving progress against every relevant competitor rather than one favorable scatter workload.

Validation

  • pre-commit run --all-files
  • ruff check .
  • ruff format --check .
  • pytest tests/test_verify_local.py tests/test_verify_ci_workflow.py tests/test_verify_sdist.py -q (148 passed)
  • python3 scripts/verify_ci_workflow.py

Summary by CodeRabbit

  • Documentation
    • Refreshed the README with clearer product positioning, customization highlights, performance context, and a broader chart roadmap.
    • Added roadmap coverage for geographic, 3D, and volume visualizations.
    • Clarified performance guidance for large datasets and benchmark methodology, including rendering modes and reproducibility details.
    • Updated contribution and production-readiness guidance, including accessibility and cross-browser verification expectations.
  • Chores
    • Streamlined local and CI verification by removing claim-specific checks and related documentation.

@coderabbitai

coderabbitai Bot commented Jul 26, 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: dca5b4e2-3f1d-46c1-8acb-43e3343f8ea6

📥 Commits

Reviewing files that changed from the base of the PR and between f7e314c and efeea9f.

📒 Files selected for processing (22)
  • .github/workflows/ci.yml
  • CLAUDE.md
  • Makefile
  • README.md
  • docs/advanced/index.md
  • docs/api-reference/contributing.md
  • docs/core-concepts/large-data-and-performance.md
  • docs/overview/benchmarks.md
  • scripts/check_claim_guardrails.py
  • scripts/verify_ci_workflow.py
  • scripts/verify_local.py
  • scripts/verify_sdist.py
  • spec/README.md
  • spec/api/chart-roadmap.md
  • spec/benchmarks/methodology.md
  • spec/benchmarks/results.md
  • spec/process/contributing.md
  • spec/process/production-readiness.md
  • tests/test_claim_guardrails.py
  • tests/test_verify_ci_workflow.py
  • tests/test_verify_local.py
  • tests/test_verify_sdist.py

📝 Walkthrough

Walkthrough

The PR removes claim-guardrail tooling and its CI, Makefile, verification, packaging, and test integrations. It also revises benchmark evidence guidance, product positioning, staged roadmap documentation, contribution requirements, and production-readiness checks.

Changes

Claim evidence and product documentation

Layer / File(s) Summary
Remove claim-guardrail execution
.github/workflows/ci.yml, Makefile, scripts/verify_local.py
Claim-guardrail execution, selection, and benchmark-harness coverage are removed from CI and local verification.
Align verification and contribution checks
scripts/verify_ci_workflow.py, scripts/verify_sdist.py, tests/test_verify_*.py, docs/api-reference/contributing.md, spec/process/contributing.md
Verification expectations, tests, package manifests, and contribution guidance are updated for the removed guardrail and renamed “Competitive Evidence” guidance.
Revise benchmark evidence documentation
README.md, docs/overview/benchmarks.md, spec/benchmarks/*, CLAUDE.md
Benchmark methodology and results now document rendering modes, reproducible comparison metadata, broader workloads, and competitive evidence.
Update positioning, roadmap, and readiness documentation
README.md, docs/advanced/index.md, docs/core-concepts/large-data-and-performance.md, spec/README.md, spec/api/chart-roadmap.md, spec/process/production-readiness.md
Product messaging shifts to staged chart coverage and broader customization, while readiness documentation adds accessibility details and removes claim-guardrail gates.

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

Possibly related PRs

  • reflex-dev/xy#300: Updates overlapping README onboarding and roadmap content.
  • reflex-dev/xy#310: Directly overlaps the claim-guardrail implementation and related tests.

Suggested reviewers: masenf, 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/readme-every-chart-every-scale

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

@codspeed-hq

codspeed-hq Bot commented Jul 26, 2026

Copy link
Copy Markdown

Merging this PR will not alter performance

✅ 103 untouched benchmarks
⏩ 2 skipped benchmarks1


Comparing agent/readme-every-chart-every-scale (efeea9f) with main (56a7a90)

Open in CodSpeed

Footnotes

  1. 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.

@Alek99
Alek99 marked this pull request as ready for review July 26, 2026 19:14
@Alek99
Alek99 merged commit 5c10892 into main Jul 26, 2026
23 of 24 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