docs: use the dynamic README header endpoint - #241
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (6)
🚧 Files skipped from review as they are similar to previous changes (6)
📝 WalkthroughWalkthroughThe repository and package READMEs replace local header images with responsive, theme-aware hosted images. The root and Preact READMEs remove GitHub repository link wrappers from stars badges. ChangesREADME branding
Estimated code review effort: 1 (Trivial) | ~5 minutes Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
|
View your CI Pipeline Execution ↗ for commit ef49ecc
☁️ Nx Cloud last updated this comment at |
Adopts the dynamic README header endpoint added in TanStack/tanstack.com#1076,
which is merged and live.
Every README banner in this repo now points a
<picture>athttps://tanstack.com/api/readme/instead of a committed PNG. The endpointrenders 1800x450 in light and dark, so a branding change lands in every README
at once and dark-mode readers get a dark banner.
What changed
<picture>, per GitHub's guidance. The trailing<img>stays the light variant, as the fallback for renderers that ignore<picture>(npm, most editors).?framework=so each banner shows its own package name instead of the generic library name.media/header_pacer.png.Verification
Every generated URL in this diff was requested against the live endpoint and
returned
200 image/pngat 1800x450.git grepconfirms no README stillreferences the old
media/header_*.pngpath.Heads up: deleting the committed PNG means npm pages for already-published
versions that embed the
raw.githubusercontent.com/.../main/media/header_*.pnglink will show a broken image, since that link is branch-pinned. New releases
pick up the endpoint URL.
Summary by CodeRabbit