Skip to content

docs: use the dynamic README header endpoint #11136

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
TkDodo merged 2 commits into from
Aug 3, 2026
Merged

docs: use the dynamic README header endpoint #11136

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3b4866f
docs: use the dynamic README header endpoint
AlemTuzlak Aug 3, 2026
bbe65e4
docs: add README header banners to the framework adapter packages
AlemTuzlak Aug 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,21 @@
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=be2d8a11-9712-4c1d-9963-580b2d4fb133" />

<div align="center">
<img src="./media/header_query.png" alt="TanStack Query" />
<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>
Comment on lines +4 to +18

@coderabbitai coderabbitai Bot Aug 3, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🩺 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-L15
  • packages/preact-query/README.md#L3-L17
  • packages/react-query/README.md#L3-L17
  • packages/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).

</div>

<br />
Expand Down
Binary file removed media/header_query.png
View file
Open in desktop
Binary file not shown.
16 changes: 15 additions & 1 deletion packages/angular-query-experimental/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,18 @@
![TanStack Query Header](https://github.com/TanStack/query/raw/main/media/repo-header.png)
<picture>
<source
media="(prefers-color-scheme: dark)"
srcset="https://tanstack.com/api/readme/query.png?framework=angular&theme=dark"
/>
<source
media="(prefers-color-scheme: light)"
srcset="https://tanstack.com/api/readme/query.png?framework=angular"
/>
<img
src="https://tanstack.com/api/readme/query.png?framework=angular"
alt="TanStack Angular Query"
width="900"
/>
</picture>

[![npm version](https://img.shields.io/npm/v/@tanstack/angular-query-experimental)](https://www.npmjs.com/package/@tanstack/angular-query-experimental)
[![npm license](https://img.shields.io/npm/l/@tanstack/angular-query-experimental)](https://github.com/TanStack/query/blob/main/LICENSE)
Expand Down
17 changes: 17 additions & 0 deletions packages/lit-query/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,20 @@
<div align="center">
<picture>
<source
media="(prefers-color-scheme: dark)"
srcset="https://tanstack.com/api/readme/query.png?framework=lit&theme=dark"
/>
<source
media="(prefers-color-scheme: light)"
srcset="https://tanstack.com/api/readme/query.png?framework=lit"
/>
<img
src="https://tanstack.com/api/readme/query.png?framework=lit"
alt="TanStack Lit Query"
width="900"
/>
</picture>
</div>
# @tanstack/lit-query

Lit adapter for `@tanstack/query-core` using Lit reactive controllers.
Expand Down
16 changes: 15 additions & 1 deletion packages/preact-query/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,20 @@
<img src="https://static.scarf.sh/a.png?x-pxid=be2d8a11-9712-4c1d-9963-580b2d4fb133" />

![TanStack Query Header](https://github.com/TanStack/query/raw/main/media/repo-header.png)
<picture>
<source
media="(prefers-color-scheme: dark)"
srcset="https://tanstack.com/api/readme/query.png?framework=preact&theme=dark"
/>
<source
media="(prefers-color-scheme: light)"
srcset="https://tanstack.com/api/readme/query.png?framework=preact"
/>
<img
src="https://tanstack.com/api/readme/query.png?framework=preact"
alt="TanStack Preact Query"
width="900"
/>
</picture>

Hooks for fetching, caching and updating asynchronous data in Preact

Expand Down
16 changes: 15 additions & 1 deletion packages/react-query/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,20 @@
<img src="https://static.scarf.sh/a.png?x-pxid=be2d8a11-9712-4c1d-9963-580b2d4fb133" />

![TanStack Query Header](https://github.com/TanStack/query/raw/main/media/repo-header.png)
<picture>
<source
media="(prefers-color-scheme: dark)"
srcset="https://tanstack.com/api/readme/query.png?framework=react&theme=dark"
/>
<source
media="(prefers-color-scheme: light)"
srcset="https://tanstack.com/api/readme/query.png?framework=react"
/>
<img
src="https://tanstack.com/api/readme/query.png?framework=react"
alt="TanStack React Query"
width="900"
/>
</picture>

Hooks for fetching, caching and updating asynchronous data in React

Expand Down
16 changes: 15 additions & 1 deletion packages/solid-query/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,20 @@
<img src="https://static.scarf.sh/a.png?x-pxid=be2d8a11-9712-4c1d-9963-580b2d4fb133" />

![TanStack Query Header](https://github.com/TanStack/query/raw/main/media/repo-header.png)
<picture>
<source
media="(prefers-color-scheme: dark)"
srcset="https://tanstack.com/api/readme/query.png?framework=solid&theme=dark"
/>
<source
media="(prefers-color-scheme: light)"
srcset="https://tanstack.com/api/readme/query.png?framework=solid"
/>
<img
src="https://tanstack.com/api/readme/query.png?framework=solid"
alt="TanStack Solid Query"
width="900"
/>
</picture>

Hooks for fetching, caching and updating asynchronous data in Solid

Expand Down
17 changes: 17 additions & 0 deletions packages/vue-query/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,20 @@
<div align="center">
<picture>
<source
media="(prefers-color-scheme: dark)"
srcset="https://tanstack.com/api/readme/query.png?framework=vue&theme=dark"
/>
<source
media="(prefers-color-scheme: light)"
srcset="https://tanstack.com/api/readme/query.png?framework=vue"
/>
<img
src="https://tanstack.com/api/readme/query.png?framework=vue"
alt="TanStack Vue Query"
width="900"
/>
</picture>
</div>
[![Vue Query logo](https://raw.githubusercontent.com/TanStack/query/main/packages/vue-query/media/vue-query.png)](https://github.com/TanStack/query/tree/main/packages/vue-query)

[![npm version](https://img.shields.io/npm/v/@tanstack/vue-query)](https://www.npmjs.com/package/@tanstack/vue-query)
Expand Down
Loading