Skip to content

docs: use the dynamic README header endpoint - #145

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

docs: use the dynamic README header endpoint#145
AlemTuzlak wants to merge 2 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.

README banners now point a <picture> at https://tanstack.com/api/readme/
instead of a committed PNG. The endpoint renders 1800x450 in light and dark, so
a branding change lands in every README at once and dark-mode readers get a
dark banner.

All 14 READMEs already had a banner, so this is a like-for-like swap. Note the package ones pointed at a relative ./media/header_hotkeys.png, which does not resolve from packages/<name>/ on GitHub or on npm - those were already broken.

Notes

  • Light and dark are served through <picture>, per GitHub's guidance. The trailing <img> stays the light variant, as the fallback for renderers that ignore <picture> (npm, most editors).
  • Only packages a user installs directly get a banner. Private and internal packages are deliberately left alone.

Verification

Every URL in this diff was requested against the live endpoint and returned
200 image/png at 1800x450. git grep confirms no README still references
the deleted asset.

Summary by CodeRabbit

  • Documentation
    • Updated README header images across the project with responsive, theme-aware light and dark variants.
    • Improved image accessibility with descriptive alternative text and consistent sizing.
    • Added fallback imagery for broader compatibility.

@coderabbitai

coderabbitai Bot commented Aug 3, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 06f8d2d1-d504-4125-bc96-6467c9e681be

📥 Commits

Reviewing files that changed from the base of the PR and between 6adcc3a and e6827cb.

⛔ Files ignored due to path filters (1)
  • media/header_hotkeys.png is excluded by !**/*.png
📒 Files selected for processing (14)
  • README.md
  • packages/angular-hotkeys/README.md
  • packages/hotkeys-devtools/README.md
  • packages/hotkeys/README.md
  • packages/lit-hotkeys/README.md
  • packages/preact-hotkeys-devtools/README.md
  • packages/preact-hotkeys/README.md
  • packages/react-hotkeys-devtools/README.md
  • packages/react-hotkeys/README.md
  • packages/solid-hotkeys-devtools/README.md
  • packages/solid-hotkeys/README.md
  • packages/svelte-hotkeys/README.md
  • packages/vue-hotkeys-devtools/README.md
  • packages/vue-hotkeys/README.md

📝 Walkthrough

Walkthrough

README headers now use responsive <picture> elements with dark- and light-theme image sources. Local header images were replaced with hosted images and updated fallback metadata.

Changes

README branding

Layer / File(s) Summary
Responsive theme-aware headers
README.md, packages/*/README.md
All root and package README headers replace local images with dark- and light-theme sources. Fallback images include updated alt text and fixed widths where specified.

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

Poem

A rabbit hops through themes so bright,
Dark source here and light source right.
The README banner finds its way,
With helpful words and width in play.
Local pixels rest today.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description explains the changes and verification, but it omits the required Changes, Checklist, and Release Impact sections. Add the required template sections and mark the Contributing, test, and docs-only release-impact items as applicable.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main change: using the dynamic README header endpoint.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.
✨ 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.

@github-actions

github-actions Bot commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

🚀 Changeset Version Preview

No changeset entries found. Merging this PR will not cause a version bump for any packages.

@pkg-pr-new

pkg-pr-new Bot commented Aug 3, 2026

Copy link
Copy Markdown

Open in StackBlitz

@tanstack/angular-hotkeys

npm i https://pkg.pr.new/@tanstack/angular-hotkeys@145

@tanstack/hotkeys

npm i https://pkg.pr.new/@tanstack/hotkeys@145

@tanstack/hotkeys-devtools

npm i https://pkg.pr.new/@tanstack/hotkeys-devtools@145

@tanstack/lit-hotkeys

npm i https://pkg.pr.new/@tanstack/lit-hotkeys@145

@tanstack/preact-hotkeys

npm i https://pkg.pr.new/@tanstack/preact-hotkeys@145

@tanstack/preact-hotkeys-devtools

npm i https://pkg.pr.new/@tanstack/preact-hotkeys-devtools@145

@tanstack/react-hotkeys

npm i https://pkg.pr.new/@tanstack/react-hotkeys@145

@tanstack/react-hotkeys-devtools

npm i https://pkg.pr.new/@tanstack/react-hotkeys-devtools@145

@tanstack/solid-hotkeys

npm i https://pkg.pr.new/@tanstack/solid-hotkeys@145

@tanstack/solid-hotkeys-devtools

npm i https://pkg.pr.new/@tanstack/solid-hotkeys-devtools@145

@tanstack/svelte-hotkeys

npm i https://pkg.pr.new/@tanstack/svelte-hotkeys@145

@tanstack/vue-hotkeys

npm i https://pkg.pr.new/@tanstack/vue-hotkeys@145

@tanstack/vue-hotkeys-devtools

npm i https://pkg.pr.new/@tanstack/vue-hotkeys-devtools@145

commit: e6827cb

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.

1 participant