Skip to content

docs: refresh core concepts and standardize example tabs#251

Merged
Alek99 merged 2 commits into
mainfrom
agent/improve-xy-core-concepts-docs
Jul 24, 2026
Merged

docs: refresh core concepts and standardize example tabs#251
Alek99 merged 2 commits into
mainfrom
agent/improve-xy-core-concepts-docs

Conversation

@Alek99

@Alek99 Alek99 commented Jul 24, 2026

Copy link
Copy Markdown
Member

Summary

  • standardize public executable examples on shared Preview/Code tabs, adding a Data tab only when a marked hardcoded-data section exceeds 10 nonblank lines
  • refine preview and code spacing and document the new example-authoring convention
  • expand the first-chart, composition, data, configuration, and interaction guides with fuller deterministic examples
  • wire the Reflex callback examples to live toasts and state-backed point/selection readouts
  • run the public quickstart contract against the PR checkout instead of coupling docs to the previously published PyPI wheel
  • add regression coverage for tab rendering, cached demos, and event-driven interaction examples

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.1 from 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 editable xy from 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 passed
  • UV_CACHE_DIR=/private/tmp/xy-docs-uv-cache uv run --project docs/app --no-sync python scripts/verify_docs_quickstart.py — passed against the checkout
  • UV_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
  • manually verified the edited documentation pages in the local production build, including tab spacing, export options, chart composition, and state-backed interactions

@coderabbitai

coderabbitai Bot commented Jul 24, 2026

Copy link
Copy Markdown

Warning

Review limit reached

@Alek99, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 27 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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 configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: de9bf0e2-4b82-40d5-892a-8929062367be

📥 Commits

Reviewing files that changed from the base of the PR and between bf073b7 and aa3c4c5.

📒 Files selected for processing (13)
  • .github/workflows/docs.yml
  • docs/app/AGENTS.md
  • docs/app/README.md
  • docs/app/tests/test_docs_site.py
  • docs/app/xy_docs/examples.py
  • docs/app/xy_docs/markdown.py
  • docs/core-concepts/configuration.md
  • docs/core-concepts/data.md
  • docs/core-concepts/index.md
  • docs/core-concepts/interactions.md
  • docs/overview/first-chart.md
  • docs/styling/examples.md
  • scripts/verify_docs_quickstart.py
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch agent/improve-xy-core-concepts-docs

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

@Alek99
Alek99 marked this pull request as ready for review July 24, 2026 17:43
@codspeed-hq

codspeed-hq Bot commented Jul 24, 2026

Copy link
Copy Markdown

Merging this PR will improve performance by 39.07%

⚡ 1 improved benchmark
✅ 101 untouched benchmarks
⏩ 1 skipped benchmark1

Performance Changes

Benchmark BASE HEAD Efficiency
test_select_lasso_message_1m 124.9 ms 89.8 ms +39.07%

Tip

Curious why this is faster? Comment @codspeedbot explain why this is faster on this PR, or directly use the CodSpeed MCP with your agent.


Comparing agent/improve-xy-core-concepts-docs (aa3c4c5) with main (bf073b7)

Open in CodSpeed

Footnotes

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

@Alek99
Alek99 merged commit d798efd into main Jul 24, 2026
28 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