Skip to content

docs: use the dynamic README header endpoint - #408

Merged
AlemTuzlak merged 1 commit into
mainfrom
readme-header-endpoint
Aug 3, 2026
Merged

docs: use the dynamic README header endpoint#408
AlemTuzlak merged 1 commit into
mainfrom
readme-header-endpoint

Conversation

@AlemTuzlak

@AlemTuzlak AlemTuzlak commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

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

What changed

  • 1 README(s) updated.

  • Light and dark 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).

  • Deletes the now-unused media/header_config.png.

Verification

Every generated 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 old media/header_*.png path.

Heads up: deleting the committed PNG means npm pages for already-published
versions that embed the raw.githubusercontent.com/.../main/media/header_*.png
link will show a broken image, since that link is branch-pinned. New releases
pick up the endpoint URL.

Summary by CodeRabbit

  • Documentation
    • Updated the README header image to adapt to light and dark themes.
    • Improved image accessibility text and display metadata.

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

@nx-cloud

nx-cloud Bot commented Aug 3, 2026

Copy link
Copy Markdown

View your CI Pipeline Execution ↗ for commit 7fb1488

Command Status Duration Result
nx run-many --target=build ✅ Succeeded <1s View ↗
nx affected --targets=test:sherif,test:docs,tes... ✅ Succeeded <1s View ↗

☁️ Nx Cloud last updated this comment at 2026-08-03 09:19:22 UTC

@pkg-pr-new

pkg-pr-new Bot commented Aug 3, 2026

Copy link
Copy Markdown
npm i https://pkg.pr.new/@tanstack/eslint-config@408
npm i https://pkg.pr.new/@tanstack/publish-config@408
npm i https://pkg.pr.new/@tanstack/typedoc-config@408
npm i https://pkg.pr.new/@tanstack/vite-config@408

commit: 7fb1488

@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: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: b7df61e9-03e3-4770-8ebe-6d2232961e58

📥 Commits

Reviewing files that changed from the base of the PR and between bfa1648 and 7fb1488.

⛔ Files ignored due to path filters (1)
  • media/header_config.png is excluded by !**/*.png
📒 Files selected for processing (1)
  • README.md

📝 Walkthrough

Walkthrough

README.md replaces the local header image with a responsive <picture> element. The element serves dark- and light-theme assets from TanStack-hosted configuration assets and includes updated alt text and width metadata.

Changes

README header image

Layer / File(s) Summary
Responsive header image
README.md
The README uses theme-specific hosted images in a responsive <picture> element. The image includes updated alt text and width metadata.

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

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the main documentation change: using the dynamic README header endpoint.
Description check ✅ Passed The description explains the changes, motivation, verification, and impact on previously published npm versions.
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.

@AlemTuzlak
AlemTuzlak merged commit 0d673e0 into main Aug 3, 2026
10 checks passed
@AlemTuzlak
AlemTuzlak deleted the readme-header-endpoint branch August 3, 2026 10:36
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