docs: refresh core concepts and standardize example tabs#251
Conversation
|
Warning Review limit reached
Next review available in: 27 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. Review details⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (13)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
Merging this PR will improve performance by 39.07%
Performance Changes
Tip Curious why this is faster? Comment Comparing Footnotes
|
Summary
Why
The documentation used different demo surfaces depending on the page, created Data tabs even for short literals, and included several sparse examples that did not clearly demonstrate chart behavior. The exact-readout interaction example also displayed compiled sample values instead of proving the Reflex event-to-state path.
The previous quickstart CI job installed
xy==0.0.1from PyPI and hardcoded the old chart title, so harmless documentation updates could fail even when the quickstart worked with the PR code. The revised contract imports editablexyfrom the checkout and keeps the meaningful standalone-HTML, offline-asset, and CSP checks.This change gives every public executable example one consistent model, keeps short examples compact, and makes the core-concept examples dense enough to demonstrate hover, selection, export, and composition behavior meaningfully.
User impact
Readers get consistent, easier-to-scan examples with copyable code, dedicated data only when it is useful, fuller charts, and interaction examples whose UI updates from real Reflex events.
Testing
UV_CACHE_DIR=/private/tmp/xy-docs-uv-cache uv run --project docs/app --no-sync pytest docs/app/tests— 89 passedUV_CACHE_DIR=/private/tmp/xy-docs-uv-cache uv run --project docs/app --no-sync python scripts/verify_docs_quickstart.py— passed against the checkoutUV_CACHE_DIR=/private/tmp/xy-docs-uv-cache uv run --project docs/app --no-sync pre-commit run --files <changed files>— ruff check, ruff format, and docs codespell passed