docs: add README header banners to the framework adapter packages - #491
Merged
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (4)
📝 WalkthroughWalkthroughThe four Devtools package README files now include centered responsive banners. Each banner selects dark- or light-theme artwork and includes descriptive image metadata. ChangesREADME banners
Estimated code review effort: 1 (Trivial) | ~2 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
|
View your CI Pipeline Execution ↗ for commit 06017fb
☁️ Nx Cloud last updated this comment at |
More templates
@tanstack/angular-devtools
@tanstack/devtools
@tanstack/devtools-a11y
@tanstack/devtools-bundler-core
@tanstack/devtools-client
@tanstack/devtools-rspack
@tanstack/devtools-ui
@tanstack/devtools-utils
@tanstack/devtools-vite
@tanstack/devtools-event-bus
@tanstack/devtools-event-client
@tanstack/preact-devtools
@tanstack/react-devtools
@tanstack/solid-devtools
@tanstack/svelte-devtools
@tanstack/vue-devtools
commit: |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Follow-up to #490, which is already merged.
That PR swapped the README banners that already existed for the
/api/readme/endpoint. It did not add banners to packages that never hadone, which left an inconsistency: sibling framework adapters in this repo now
look different from each other purely because of which PNG happened to be
committed before.
This adds the banner to the public framework adapter packages that were
missed:
@tanstack/react-devtools,@tanstack/preact-devtools,@tanstack/solid-devtools,@tanstack/vue-devtools.Scope
Only packages a user installs directly. Internal packages are deliberately
left banner-free - a branded header on plumbing nobody browses is noise:
*-corepackages and internal client/server split packagesVerification
Every URL added here was requested against the live endpoint and returned
200 image/pngat 1800x450. Light and dark are served through<picture>,with the trailing
<img>left as the light variant so renderers that ignore<picture>(npm, most editors) still show a banner.Summary by CodeRabbit