Skip to content

docs: use the dynamic README header endpoint #6505

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
KevinVandy merged 1 commit into from
Aug 3, 2026
+270 −18
Merged

docs: use the dynamic README header endpoint #6505

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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,5 +1,19 @@
<div align="center">
<img src="./media/header_table.png" alt="TanStack Table">
<picture>
<source
media="(prefers-color-scheme: dark)"
srcset="https://tanstack.com/api/readme/table.png?theme=dark"
/>
<source
media="(prefers-color-scheme: light)"
srcset="https://tanstack.com/api/readme/table.png"
/>
<img
src="https://tanstack.com/api/readme/table.png"
alt="TanStack Table"
width="900"
/>
</picture>
</div>

<br />
Expand Down
16 changes: 15 additions & 1 deletion packages/alpine-table/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,19 @@
<div align="center">
<img src="./media/header_table.png" alt="TanStack Table">
<picture>
<source
media="(prefers-color-scheme: dark)"
srcset="https://tanstack.com/api/readme/table.png?framework=alpine&theme=dark"
/>
<source
media="(prefers-color-scheme: light)"
srcset="https://tanstack.com/api/readme/table.png?framework=alpine"
/>
<img
src="https://tanstack.com/api/readme/table.png?framework=alpine"
alt="TanStack Alpine Table"
width="900"
/>
</picture>
</div>

<br />
Expand Down
16 changes: 15 additions & 1 deletion packages/angular-table/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,19 @@
<div align="center">
<img src="./media/header_table.png" alt="TanStack Table">
<picture>
<source
media="(prefers-color-scheme: dark)"
srcset="https://tanstack.com/api/readme/table.png?framework=angular&theme=dark"
/>
<source
media="(prefers-color-scheme: light)"
srcset="https://tanstack.com/api/readme/table.png?framework=angular"
/>
<img
src="https://tanstack.com/api/readme/table.png?framework=angular"
alt="TanStack Angular Table"
width="900"
/>
</picture>
</div>

<br />
Expand Down
16 changes: 15 additions & 1 deletion packages/ember-table/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,19 @@
<div align="center">
<img src="./media/header_table.png" alt="TanStack Table">
<picture>
<source
media="(prefers-color-scheme: dark)"
srcset="https://tanstack.com/api/readme/table.png?framework=ember&theme=dark"
/>
<source
media="(prefers-color-scheme: light)"
srcset="https://tanstack.com/api/readme/table.png?framework=ember"
/>
<img
src="https://tanstack.com/api/readme/table.png?framework=ember"
alt="TanStack Ember Table"
width="900"
/>
</picture>
</div>

<br />
Expand Down
16 changes: 15 additions & 1 deletion packages/lit-table/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,19 @@
<div align="center">
<img src="./media/header_table.png" alt="TanStack Table">
<picture>
<source
media="(prefers-color-scheme: dark)"
srcset="https://tanstack.com/api/readme/table.png?framework=lit&theme=dark"
/>
<source
media="(prefers-color-scheme: light)"
srcset="https://tanstack.com/api/readme/table.png?framework=lit"
/>
<img
src="https://tanstack.com/api/readme/table.png?framework=lit"
alt="TanStack Lit Table"
width="900"
/>
</picture>
</div>

<br />
Expand Down
16 changes: 15 additions & 1 deletion packages/match-sorter-utils/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,19 @@
<div align="center">
<img src="./media/header_table.png" alt="TanStack Table">
<picture>
<source
media="(prefers-color-scheme: dark)"
srcset="https://tanstack.com/api/readme/table.png?theme=dark"
/>
<source
media="(prefers-color-scheme: light)"
srcset="https://tanstack.com/api/readme/table.png"
/>
<img
src="https://tanstack.com/api/readme/table.png"
alt="TanStack Table"
Comment on lines +5 to +13

@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.

🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
set -euo pipefail

printf 'Repository files matching README names:\n'
git ls-files | grep -E '(^|/)README\.md$' | sed -n '1,80p'

printf '\nTarget README contents lines 1-30:\n'
if [ -f packages/match-sorter-utils/README.md ]; then
  cat -n packages/match-sorter-utils/README.md | sed -n '1,40p'
else
  echo 'packages/match-sorter-utils/README.md not found'
fi

printf '\nPattern for package README headers in repo:\n'
rg -n 'framework=match-sorter-utils|framework=table|srcset="https://tanstack\.com/api/readme/table\.png|alt="TanStack' packages -g 'README.md' | sed -n '1,200p'

Repository: TanStack/table

Length of output: 7654

🌐 Web query:

TanStack documentation static readme images framework table.png

💡 Result:

The TanStack Table repository uses various images in its documentation, including header images often located in a /media directory within the source code [1][2]. Specific images like table.png have appeared in the repository's README or media assets, such as header_table.png [1], though these file names may change or be updated alongside the library's evolution. Because TanStack Table is a headless library, it does not mandate a specific UI, so images in the documentation generally serve to demonstrate the library's branding or common usage patterns rather than required UI components [3][4][5]. If you are looking for specific assets, they are typically found in the repository under the media/ folder [1], or hosted as public assets for use in the documentation at tanstack.com [1]. Note that older versions (e.g., React Table v6) used different branding, such as logo-react-table.png [6][7].

Citations:

Use an available package-specific header for @tanstack/match-sorter-utils.

The README currently uses the generic Table header URLs and alt="TanStack Table", which makes this package README inconsistent with other TanStack Table packages that include framework= in their header URLs. Use a supported match-sorter-utils header URL if one is provided; otherwise keep the generic header but change the alt text so the image describes its package.

🤖 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 `@packages/match-sorter-utils/README.md` around lines 5 - 13, Update the README
header image block to use an available package-specific match-sorter-utils
header URL, including the established framework query parameter when supported;
otherwise retain the generic image URLs but change the img alt text from
“TanStack Table” to accurately describe `@tanstack/match-sorter-utils`.

width="900"
/>
</picture>
</div>

<br />
Expand Down
16 changes: 15 additions & 1 deletion packages/octane-table/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,19 @@
<div align="center">
<img src="./media/header_table.png" alt="TanStack Table">
<picture>
<source
media="(prefers-color-scheme: dark)"
srcset="https://tanstack.com/api/readme/table.png?framework=octane&theme=dark"
/>
<source
media="(prefers-color-scheme: light)"
srcset="https://tanstack.com/api/readme/table.png?framework=octane"
/>
<img
src="https://tanstack.com/api/readme/table.png?framework=octane"
alt="TanStack Octane Table"
width="900"
/>
</picture>
</div>

<br />
Expand Down
16 changes: 15 additions & 1 deletion packages/preact-table-devtools/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,19 @@
<div align="center">
<img src="./media/header_table.png" alt="TanStack Table">
<picture>
<source
media="(prefers-color-scheme: dark)"
srcset="https://tanstack.com/api/readme/table.png?framework=preact&theme=dark"
/>
<source
media="(prefers-color-scheme: light)"
srcset="https://tanstack.com/api/readme/table.png?framework=preact"
/>
<img
src="https://tanstack.com/api/readme/table.png?framework=preact"
alt="TanStack Preact Table"
width="900"
/>
</picture>
</div>

<br />
Expand Down
16 changes: 15 additions & 1 deletion packages/preact-table/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,19 @@
<div align="center">
<img src="./media/header_table.png" alt="TanStack Table">
<picture>
<source
media="(prefers-color-scheme: dark)"
srcset="https://tanstack.com/api/readme/table.png?framework=preact&theme=dark"
/>
<source
media="(prefers-color-scheme: light)"
srcset="https://tanstack.com/api/readme/table.png?framework=preact"
/>
<img
src="https://tanstack.com/api/readme/table.png?framework=preact"
alt="TanStack Preact Table"
width="900"
/>
</picture>
</div>

<br />
Expand Down
16 changes: 15 additions & 1 deletion packages/react-table-devtools/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,19 @@
<div align="center">
<img src="./media/header_table.png" alt="TanStack Table">
<picture>
<source
media="(prefers-color-scheme: dark)"
srcset="https://tanstack.com/api/readme/table.png?framework=react&theme=dark"
/>
<source
media="(prefers-color-scheme: light)"
srcset="https://tanstack.com/api/readme/table.png?framework=react"
/>
<img
src="https://tanstack.com/api/readme/table.png?framework=react"
alt="TanStack React Table"
width="900"
/>
</picture>
</div>

<br />
Expand Down
16 changes: 15 additions & 1 deletion packages/react-table/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,19 @@
<div align="center">
<img src="./media/header_table.png" alt="TanStack Table">
<picture>
<source
media="(prefers-color-scheme: dark)"
srcset="https://tanstack.com/api/readme/table.png?framework=react&theme=dark"
/>
<source
media="(prefers-color-scheme: light)"
srcset="https://tanstack.com/api/readme/table.png?framework=react"
/>
<img
src="https://tanstack.com/api/readme/table.png?framework=react"
alt="TanStack React Table"
width="900"
/>
</picture>
</div>

<br />
Expand Down
16 changes: 15 additions & 1 deletion packages/solid-table-devtools/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,19 @@
<div align="center">
<img src="./media/header_table.png" alt="TanStack Table">
<picture>
<source
media="(prefers-color-scheme: dark)"
srcset="https://tanstack.com/api/readme/table.png?framework=solid&theme=dark"
/>
<source
media="(prefers-color-scheme: light)"
srcset="https://tanstack.com/api/readme/table.png?framework=solid"
/>
<img
src="https://tanstack.com/api/readme/table.png?framework=solid"
alt="TanStack Solid Table"
width="900"
/>
</picture>
</div>

<br />
Expand Down
16 changes: 15 additions & 1 deletion packages/solid-table/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,19 @@
<div align="center">
<img src="./media/header_table.png" alt="TanStack Table">
<picture>
<source
media="(prefers-color-scheme: dark)"
srcset="https://tanstack.com/api/readme/table.png?framework=solid&theme=dark"
/>
<source
media="(prefers-color-scheme: light)"
srcset="https://tanstack.com/api/readme/table.png?framework=solid"
/>
<img
src="https://tanstack.com/api/readme/table.png?framework=solid"
alt="TanStack Solid Table"
width="900"
/>
</picture>
</div>

<br />
Expand Down
16 changes: 15 additions & 1 deletion packages/svelte-table/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,19 @@
<div align="center">
<img src="./media/header_table.png" alt="TanStack Table">
<picture>
<source
media="(prefers-color-scheme: dark)"
srcset="https://tanstack.com/api/readme/table.png?framework=svelte&theme=dark"
/>
<source
media="(prefers-color-scheme: light)"
srcset="https://tanstack.com/api/readme/table.png?framework=svelte"
/>
<img
src="https://tanstack.com/api/readme/table.png?framework=svelte"
alt="TanStack Svelte Table"
width="900"
/>
</picture>
</div>

<br />
Expand Down
16 changes: 15 additions & 1 deletion packages/table-core/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,19 @@
<div align="center">
<img src="./media/header_table.png" alt="TanStack Table">
<picture>
<source
media="(prefers-color-scheme: dark)"
srcset="https://tanstack.com/api/readme/table.png?theme=dark"
/>
<source
media="(prefers-color-scheme: light)"
srcset="https://tanstack.com/api/readme/table.png"
/>
<img
src="https://tanstack.com/api/readme/table.png"
alt="TanStack Table"
width="900"
/>
</picture>
</div>

<br />
Expand Down
16 changes: 15 additions & 1 deletion packages/table-devtools/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,19 @@
<div align="center">
<img src="./media/header_table.png" alt="TanStack Table">
<picture>
<source
media="(prefers-color-scheme: dark)"
srcset="https://tanstack.com/api/readme/table.png?theme=dark"
/>
<source
media="(prefers-color-scheme: light)"
srcset="https://tanstack.com/api/readme/table.png"
/>
<img
src="https://tanstack.com/api/readme/table.png"
alt="TanStack Table"
width="900"
/>
</picture>
</div>

<br />
Expand Down
16 changes: 15 additions & 1 deletion packages/vue-table-devtools/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,19 @@
<div align="center">
<img src="./media/header_table.png" alt="TanStack Table">
<picture>
<source
media="(prefers-color-scheme: dark)"
srcset="https://tanstack.com/api/readme/table.png?framework=vue&theme=dark"
/>
<source
media="(prefers-color-scheme: light)"
srcset="https://tanstack.com/api/readme/table.png?framework=vue"
/>
<img
src="https://tanstack.com/api/readme/table.png?framework=vue"
alt="TanStack Vue Table"
width="900"
/>
</picture>
</div>

<br />
Expand Down
16 changes: 15 additions & 1 deletion packages/vue-table/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,19 @@
<div align="center">
<img src="./media/header_table.png" alt="TanStack Table">
<picture>
<source
media="(prefers-color-scheme: dark)"
srcset="https://tanstack.com/api/readme/table.png?framework=vue&theme=dark"
/>
<source
media="(prefers-color-scheme: light)"
srcset="https://tanstack.com/api/readme/table.png?framework=vue"
/>
<img
src="https://tanstack.com/api/readme/table.png?framework=vue"
alt="TanStack Vue Table"
width="900"
/>
</picture>
</div>

<br />
Expand Down
Loading