Skip to content

docs: use the dynamic README header endpoint - #241

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

docs: use the dynamic README header endpoint#241
AlemTuzlak wants to merge 2 commits into
mainfrom
readme-header-endpoint

Conversation

@AlemTuzlak

@AlemTuzlak AlemTuzlak commented Aug 3, 2026

Copy link
Copy Markdown
Collaborator

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

  • 11 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).
  • Per-package READMEs pass ?framework= so each banner shows its own package name instead of the generic library name.
  • Deletes the now-unused media/header_pacer.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 README branding across packages with responsive light- and dark-theme header images.
    • Added clearer, package-specific alternative text and consistent image sizing.
    • Removed repository link wrappers around selected stars badges.

Copilot AI review requested due to automatic review settings August 3, 2026 09:20
@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: ed945d26-4ef6-4d5f-bed1-c4cfc9c8ec16

📥 Commits

Reviewing files that changed from the base of the PR and between ef49ecc and ac2398e.

📒 Files selected for processing (6)
  • packages/angular-pacer/README.md
  • packages/preact-pacer-devtools/README.md
  • packages/react-pacer-devtools/README.md
  • packages/react-pacer/README.md
  • packages/solid-pacer-devtools/README.md
  • packages/solid-pacer/README.md
🚧 Files skipped from review as they are similar to previous changes (6)
  • packages/react-pacer-devtools/README.md
  • packages/react-pacer/README.md
  • packages/solid-pacer-devtools/README.md
  • packages/solid-pacer/README.md
  • packages/angular-pacer/README.md
  • packages/preact-pacer-devtools/README.md

📝 Walkthrough

Walkthrough

The repository and package READMEs replace local header images with responsive, theme-aware hosted images. The root and Preact READMEs remove GitHub repository link wrappers from stars badges.

Changes

README branding

Layer / File(s) Summary
Responsive README headers and badge markup
README.md, packages/*/README.md
README headers now use hosted dark- and light-theme Pacer images with accessibility metadata. The root, Preact, and Solid READMEs remove GitHub repository link wrappers from stars badges.

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

Suggested reviewers: copilot

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main documentation change to use the dynamic README header endpoint.
Description check ✅ Passed The description explains the changes, motivation, verification, and release impact in sufficient detail.
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.

@nx-cloud

nx-cloud Bot commented Aug 3, 2026

Copy link
Copy Markdown

View your CI Pipeline Execution ↗ for commit ef49ecc

Command Status Duration Result
nx run-many --targets=build --exclude=examples/** ✅ Succeeded 17s View ↗

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

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

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.

2 participants