Skip to content

docs: use the dynamic README header endpoint - #54

Open
AlemTuzlak wants to merge 3 commits into
mainfrom
readme-header-endpoint
Open

docs: use the dynamic README header endpoint#54
AlemTuzlak wants to merge 3 commits into
mainfrom
readme-header-endpoint

Conversation

@AlemTuzlak

@AlemTuzlak AlemTuzlak commented Aug 3, 2026

Copy link
Copy Markdown

Adopts the dynamic README header endpoint added in TanStack/tanstack.com#1076, which is merged and live.\n\nThe root README and all 12 public package READMEs now use a picture element with light and dark images. Recognized framework adapters use the endpoint's framework parameter. React Native and Charts Scales use explicit titles because they are not listed as site frameworks. Private and internal packages are intentionally unchanged.\n\nThe trailing image remains the light variant so npm and editors that ignore picture sources still show a useful banner.\n\n## Verification\n\n- Every unique URL in this PR returned 200 image/png at 1800x450.\n- Light and dark images were visually checked, including React Native and Charts Scales.\n- All public packages are covered and private packages are excluded.\n- A local merge into current main passed formatting, documentation, and packed package validation.\n- No README references the deleted local image.

Summary by CodeRabbit

  • Documentation
    • Added responsive README banners across chart packages.
    • Banners display theme-specific artwork for light and dark color schemes.
    • Added framework-specific chart artwork for supported packages.
    • Improved image accessibility with descriptive alternative text and image metadata.
    • Updated the main README header to use responsive, theme-aware imagery.
    • Removed the previous local header image asset.

@coderabbitai

coderabbitai Bot commented Aug 3, 2026

Copy link
Copy Markdown

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: b47540fc-e42f-4bf6-9381-98ffefa0d807

📥 Commits

Reviewing files that changed from the base of the PR and between d4e9e69 and 699e8e2.

📒 Files selected for processing (9)
  • packages/alpine-charts/README.md
  • packages/angular-charts/README.md
  • packages/charts-scales/README.md
  • packages/lit-charts/README.md
  • packages/octane-charts/README.md
  • packages/preact-charts/README.md
  • packages/solid-charts/README.md
  • packages/svelte-charts/README.md
  • packages/vue-charts/README.md
🚧 Files skipped from review as they are similar to previous changes (8)
  • packages/lit-charts/README.md
  • packages/octane-charts/README.md
  • packages/svelte-charts/README.md
  • packages/alpine-charts/README.md
  • packages/vue-charts/README.md
  • packages/solid-charts/README.md
  • packages/charts-scales/README.md
  • packages/angular-charts/README.md

Included review availability: Your plan provides up to 4 included reviews per hour; 2 remain after this review.


📝 Walkthrough

Walkthrough

The repository and package READMEs now use centered, responsive <picture> banners. Each banner selects dark or light artwork based on the color scheme and includes accessible image metadata. The root README no longer uses the local header image.

Changes

README banner updates

Layer / File(s) Summary
Repository README banner
README.md
The local header image was replaced with a hosted responsive <picture> element that selects dark or light artwork and includes accessible metadata.
Package README banners
packages/*/README.md
Package READMEs now include centered responsive banners with theme-specific and framework-specific image sources, fallback images, and descriptive image metadata.

Priority: ⬇️ Low

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

Merge Risk: ⚪ Minimal · up to 699e8

This change updates repository and package README banners to use responsive hosted light and dark artwork. It does not alter runtime behavior, and no merge-blocking risk is currently evidenced.

Suggested reviewers: tannerlinsley

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
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 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the main change: replacing committed README header images with the dynamic README header endpoint.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch readme-header-endpoint

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.

…ader

# Conflicts:
#	packages/charts-scales/README.md
@coderabbitai

coderabbitai Bot commented Sep 3, 2026

Copy link
Copy Markdown

Note

GitHub couldn't provide a complete incremental comparison for this pull request, so CodeRabbit is performing a full review instead. This review may take a little longer.

@nx-cloud

nx-cloud Bot commented Sep 3, 2026

Copy link
Copy Markdown

View your CI Pipeline Execution ↗ for commit 699e8e2

Command Status Duration Result
nx run-many --targets=format-check,docs-check,d... ✅ Succeeded 1m 21s View ↗

☁️ Nx Cloud last updated this comment at 2026-09-09 22:45:12 UTC

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.

2 participants