docs: use the dynamic README header endpoint - #11136
Open
AlemTuzlak wants to merge 2 commits into
Open
Conversation
Contributor
|
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 (2)
📝 WalkthroughWalkthroughThe repository and package README headers now use responsive ChangesREADME header images
Estimated code review effort: 1 (Trivial) | ~5 minutes 🚥 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 |
Contributor
🚀 Changeset Version PreviewNo changeset entries found. Merging this PR will not cause a version bump for any packages. |
|
View your CI Pipeline Execution ↗ for commit bbe65e4
☁️ Nx Cloud last updated this comment at |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.md`:
- Around line 4-18: Preserve the legacy media/header_query.png URL as a stable
asset or replacement, and ensure the README image references remain compatible
across README.md (lines 4-18), packages/angular-query-experimental/README.md
(lines 1-15), packages/preact-query/README.md (lines 3-17),
packages/react-query/README.md (lines 3-17), and packages/solid-query/README.md
(lines 3-17).
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: eb80d33d-ac05-48b4-9e2e-47bfe0c8f816
⛔ Files ignored due to path filters (1)
media/header_query.pngis excluded by!**/*.png
📒 Files selected for processing (5)
README.mdpackages/angular-query-experimental/README.mdpackages/preact-query/README.mdpackages/react-query/README.mdpackages/solid-query/README.md
Comment on lines
+4
to
+18
| <picture> | ||
| <source | ||
| media="(prefers-color-scheme: dark)" | ||
| srcset="https://tanstack.com/api/readme/query.png?theme=dark" | ||
| /> | ||
| <source | ||
| media="(prefers-color-scheme: light)" | ||
| srcset="https://tanstack.com/api/readme/query.png" | ||
| /> | ||
| <img | ||
| src="https://tanstack.com/api/readme/query.png" | ||
| alt="TanStack Query" | ||
| width="900" | ||
| /> | ||
| </picture> |
Contributor
There was a problem hiding this comment.
🩺 Stability & Availability | 🟠 Major | ⚡ Quick win
Preserve the old header URL for published README compatibility.
Removing media/header_query.png breaks previously published npm README images. Keep the asset or provide a stable replacement at the old URL.
README.md#L4-L18: preserve compatibility for the repository README reference.packages/angular-query-experimental/README.md#L1-L15: preserve compatibility for Angular Query releases.packages/preact-query/README.md#L3-L17: preserve compatibility for Preact Query releases.packages/react-query/README.md#L3-L17: preserve compatibility for React Query releases.packages/solid-query/README.md#L3-L17: preserve compatibility for Solid Query releases.
📍 Affects 5 files
README.md#L4-L18(this comment)packages/angular-query-experimental/README.md#L1-L15packages/preact-query/README.md#L3-L17packages/react-query/README.md#L3-L17packages/solid-query/README.md#L3-L17
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@README.md` around lines 4 - 18, Preserve the legacy media/header_query.png
URL as a stable asset or replacement, and ensure the README image references
remain compatible across README.md (lines 4-18),
packages/angular-query-experimental/README.md (lines 1-15),
packages/preact-query/README.md (lines 3-17), packages/react-query/README.md
(lines 3-17), and packages/solid-query/README.md (lines 3-17).
Contributor
size-limit report 📦
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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_query.png.The package READMEs were pointing at
media/repo-header.png, the GitHub social-preview image. That file stays where it is - only the README references change.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