Skip to content

docs: clarify Canvas 2D support in comparison - #242

Merged
tannerlinsley merged 1 commit into
mainfrom
taren/docs-canvas-webgl
Oct 22, 2026
Merged

tannerlinsley merged 1 commit into
mainfrom
taren/docs-canvas-webgl

Conversation

@tannerlinsley

@tannerlinsley tannerlinsley commented Oct 22, 2026 •

Copy link
Copy Markdown
Member

Thanks to @Julien76 for pointing out the ambiguity. The comparison now names the optional Canvas 2D renderer and explicitly says there is no WebGL renderer. This does not make a roadmap commitment.

Fixes #241.

AI review notes:
Updated the shared comparison capability data, the canonical documentation, and its generated package copy.
The documentation contract passed for 105 pages, 55 catalog examples, 32 runnable groups, and 8 standalone examples. Formatting and diff checks passed.
No runtime source, dependencies, size limits, or benchmark tolerances changed. Bundle and runtime effects were assessed by inspecting the docs-only diff, not by running benchmarks.

Summary by CodeRabbit

  • Documentation
    • Updated the renderer comparison to clarify that TanStack Charts offers optional Canvas 2D rendering and does not provide a WebGL renderer.
    • Renderer availability is now distinguished by output type across the compared libraries, including optional, selected-chart, and no first-party renderer cases.
    • Existing framework-neutral core and licensing information remains unchanged.

@changeset-bot

changeset-bot Bot commented Oct 22, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: a0cb0f4

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@coderabbitai

coderabbitai Bot commented Oct 22, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 2f757071-73e8-4fd9-a113-777efffaf81d
📥 Commits

Reviewing files that changed from the base of the PR and between a2e82ab and a0cb0f4.

📒 Files selected for processing: 3
  • docs/comparison.md
  • packages/charts-core/docs/comparison.md
  • scripts/benchmark/comparison-capabilities.mjs

Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 3 remain after this review.

📝 Walkthrough

The comparison tables now identify TanStack Charts’ optional Canvas 2D renderer and state that it has no WebGL renderer. The benchmark capability entry uses the same description.

Changes: Renderer capability descriptions

Layer / File(s) Summary
Update renderer capability descriptions
docs/comparison.md, packages/charts-core/docs/comparison.md, scripts/benchmark/comparison-capabilities.mjs
The comparison documentation and benchmark entry specify optional Canvas 2D support and no WebGL renderer for TanStack Charts. The top-level comparison also clarifies renderer availability for other libraries.

Priority: ⬇️ Low

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

Change: Other · Severity of issue fixed: Low

Suggested reviewers: greglum

Merge Risk: ⚪ Minimal · up to a0cb0

No actionable merge risk remains; the documentation clarification is consistent across the updated surfaces.

Pre-merge checks: Passed 5
Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title clearly describes the documentation change about Canvas 2D support. It does not mention the related clarification that no WebGL renderer exists, but it remains specific and relevant.
Linked Issues check Passed Issue #241 requires documentation to distinguish Canvas renderer support from WebGL support. The PR changes the shared capability entry to Optional Canvas 2D; no WebGL renderer. It updates both `doc…
Out of Scope Changes check Passed The diff changes only the comparison capability declaration and its two documentation copies. The table alignment changes support the updated documentation. No runtime source, dependency, benchmark, o…
Docstring Coverage Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 1…
Full details: Linked Issues check

Explanation

Issue #241 requires documentation to distinguish Canvas renderer support from WebGL support. The PR changes the shared capability entry to Optional Canvas 2D; no WebGL renderer. It updates both docs/comparison.md and packages/charts-core/docs/comparison.md with the same wording. The change directly clarifies the comparison and makes no roadmap claim.

Full details: Out of Scope Changes check

Explanation

The diff changes only the comparison capability declaration and its two documentation copies. The table alignment changes support the updated documentation. No runtime source, dependency, benchmark, or unrelated feature change is present.

Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 1 files. (2 skipped: 2 unsupported.)

✨ Finishing Touches
📝 Generate docstrings
  • Commit to this branch
  • Create a new PR
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@nx-cloud

nx-cloud Bot commented Oct 22, 2026 •

Copy link
Copy Markdown

View your CI Pipeline Execution ↗ for commit a0cb0f4

Command Status Duration Result
nx run charts-workspace:ci-distributed ✅ Succeeded 5m 40s View ↗
nx run charts-workspace:package-check ✅ Succeeded 2m 23s View ↗
nx run charts-workspace:benchmark-check ✅ Succeeded 1m 13s View ↗

☁️ Nx Cloud last updated this comment at 2026-10-22 08:00:36 UTC

@tannerlinsley
tannerlinsley merged commit 478de43 into main Oct 22, 2026
16 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.

[Docs] Potential misleading comparison table regarding web-gl support

1 participant