docs: README Updates #9640
Merged
docs: README Updates #9640
Conversation
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
Contributor
WalkthroughREADME.md was overhauled: header and badges replaced with a centered local image, hero rewritten with a concise description and feature bullets, docs CTA added, legacy/versioned sections removed, Get Involved and Explore the TanStack Ecosystem sections added, and partners/contributing/layout updated. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Pre-merge checks (3 passed)✅ Passed checks (3 passed)
Poem
Tip 👮 Agentic pre-merge checks are now available in preview!Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.
Please see the documentation for more information. Example: reviews:
pre_merge_checks:
custom_checks:
- name: "Undocumented Breaking Changes"
mode: "warning"
instructions: |
Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).Please share your feedback with us on this Discord post. ✨ Finishing touches🧪 Generate unit tests
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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 4
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
README.md (1)
3-74: Fix duplicate attributes, update link targets, and verify external URLs
- Remove duplicate
altattributes on badge images in README.md (e.g. the shields at lines ~21, 24, 27).- Remove or correct
target="_parent"on links (lines ~20, 23, 26); GitHub strips those attributes.- Replace
./media/header_query.pngwith an absolute URL for npm-hosted README.- Manually verify all external badges and links: npm download badge, Best of JS endpoint, bundle-size badge, and the Discord invite (WrRKjPJ).
🧹 Nitpick comments (4)
README.md (4)
14-16: Inline style won’t render on GitHubGitHub strips most inline style attributes. Use semantic markup instead.
-<a href="https://tanstack.com/query" style="font-weight: bold">Read the Query Docs →</a> +<a href="https://tanstack.com/query"><strong>Read the Query Docs →</strong></a>
17-17: Superfluous inline stylesThe flex styles will be ignored by GitHub; simpler markup is safer.
-<div align="center" style="display: flex; gap: 10px; flex-direction: column; justify-content: center;"> +<div align="center">
56-74: Optional: inline styles in Partners sectionThe flex styles may be stripped on GitHub; content will degrade to a vertical list. Acceptable, but consider removing styles or using simple center alignment for predictable rendering.
Do you want this layout to render identically on npm and GitHub? If yes, I can propose a style-free variant.
36-36: Minor: Badge alt text handle mismatchAlt says “Follow @TanStack” but the handle is @tan_stack.
- <a href="https://twitter.com/tan_stack"><img src="https://img.shields.io/twitter/follow/tan_stack.svg?style=social" alt="Follow @TanStack"/></a> + <a href="https://twitter.com/tan_stack"><img src="https://img.shields.io/twitter/follow/tan_stack.svg?style=social" alt="Follow @tan_stack"/></a>
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
media/header_query.pngis excluded by!**/*.png
📒 Files selected for processing (1)
README.md(2 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
README.md
4-4: Images should have alternate text (alt text)
(MD045, no-alt-text)
🔇 Additional comments (1)
README.md (1)
3-5: Add alt text to header image in README.md
Add analtattribute to satisfy MD045. For example:- <img src="./media/header_query.png"> + <img alt="TanStack Query" src="./media/header_query.png">
Comment on lines
78
to
91
| <div align="center"> | ||
| <a href="https://github.com/tanstack/config" style="font-weight: bold;">TanStack Config</a> – Tooling for JS/TS packages <br/> | ||
| <a href="https://github.com/tanstack/db" style="font-weight: bold;">TanStack DB</a> – Reactive sync client store <br/> | ||
| <a href="https://github.com/tanstack/config" style="font-weight: bold;">TanStack DevTools</a> – Unified devtools panel <br/> | ||
| <a href="https://github.com/tanstack/form" style="font-weight: bold;">TanStack Form</a> – Type‑safe form state <br/> | ||
| <a href="https://github.com/tanstack/pacer" style="font-weight: bold;">TanStack Pacer</a> – Debouncing, throttling, batching <br/> | ||
| <a href="https://github.com/tanstack/ranger" style="font-weight: bold;">TanStack Ranger</a> – Range & slider primitives <br/> | ||
| <a href="https://github.com/tanstack/router" style="font-weight: bold;">TanStack Router</a> – Type‑safe routing, caching & URL state<br/> | ||
| <a href="https://github.com/tanstack/router" style="font-weight: bold;">TanStack Start</a> – Full‑stack SSR & streaming<br/> | ||
| <a href="https://github.com/tanstack/store" style="font-weight: bold;">TanStack Store</a> – Reactive data store <br/> | ||
| <a href="https://github.com/tanstack/table" style="font-weight: bold;">TanStack Table</a> – Headless datagrids <br/> | ||
| <a href="https://github.com/tanstack/virtual" style="font-weight: bold;">TanStack Virtual</a> – Virtualized rendering <br/> | ||
| … and more at <a href="https://tanstack.com" style="font-weight: bold;">TanStack.com »</a> | ||
| </div> |
Contributor
There was a problem hiding this comment.
💡 Verification agent
❓ Verification inconclusive
Fix likely copy/paste link errors in Ecosystem
DevTools and Start link to the wrong repos.
- <a href="https://github.com/tanstack/config" style="font-weight: bold;">TanStack DevTools</a> – Unified devtools panel <br/>
+ <a href="https://github.com/tanstack/devtools" style="font-weight: bold;">TanStack DevTools</a> – Unified devtools panel <br/>
@@
- <a href="https://github.com/tanstack/router" style="font-weight: bold;">TanStack Start</a> – Full‑stack SSR & streaming<br/>
+ <a href="https://github.com/tanstack/start" style="font-weight: bold;">TanStack Start</a> – Full‑stack SSR & streaming<br/>Also consider removing inline styles across this block for consistency with GitHub’s sanitizer.
Fix copy/paste link errors and remove inline styles
- Change TanStack DevTools href to https://github.com/tanstack/devtools
- Change TanStack Start href to https://github.com/tanstack/start
- Remove all
style="font-weight: bold;"attributes across this block for consistency with GitHub’s sanitizer
🤖 Prompt for AI Agents
In README.md around lines 78 to 91, there are copy/paste link errors and inline
style attributes; update the TanStack DevTools link href to
https://github.com/tanstack/devtools and the TanStack Start link href to
https://github.com/tanstack/start, and remove all style="font-weight: bold;"
attributes in this block so links rely on normal markdown/HTML styling and are
compatible with GitHub’s sanitizer.
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (4)
README.md (4)
17-29: Clean badges block: drop target attributes and duplicate alt; avoid inline styles
- target="..." is stripped by GitHub.
- Each
has duplicate alt; keep a single meaningful alt.
- The outer div’s style won’t render; remove it.
-<div align="center" style="display: flex; gap: 10px; flex-direction: column; justify-content: center;"> +<div align="center"> @@ -<a href="https://www.npmjs.com/package/@tanstack/query-core" target="\_parent"> - <img alt="" src="https://img.shields.io/npm/dm/@tanstack/query-core.svg" alt="npm downloads" /> +<a href="https://www.npmjs.com/package/@tanstack/query-core"> + <img alt="npm downloads" src="https://img.shields.io/npm/dm/@tanstack/query-core.svg" /> </a> - <a href="https://github.com/TanStack/query/" target="\_parent"> - <img alt="" src="https://img.shields.io/github/stars/TanStack/query.svg?style=social&label=Star" alt="GitHub stars" /> + <a href="https://github.com/TanStack/query/"> + <img alt="GitHub stars" src="https://img.shields.io/github/stars/TanStack/query.svg?style=social&label=Star" /> </a> -<a href="https://bundlejs.com/?q=%40tanstack%2Freact-query&config=%7B%22esbuild%22%3A%7B%22external%22%3A%5B%22react%22%2C%22react-dom%22%5D%7D%7D&badge=" target="\_parent"> - <img alt="" src="https://deno.bundlejs.com/?q=@tanstack/react-query&config={%22esbuild%22:{%22external%22:[%22react%22,%22react-dom%22]}}&badge=detailed" alt="Bundle size" /> +<a href="https://bundlejs.com/?q=%40tanstack%2Freact-query&config=%7B%22esbuild%22%3A%7B%22external%22%3A%5B%22react%22%2C%22react-dom%22%5D%7D%7D&badge="> + <img alt="Bundle size" src="https://deno.bundlejs.com/?q=@tanstack/react-query&config={%22esbuild%22:{%22external%22:[%22react%22,%22react-dom%22]}}&badge=detailed" /> </a>
31-37: Fix broken anchor on semantic-release badgehref="#badge" points nowhere; link to the project instead.
-<a href="#badge"> +<a href="https://github.com/semantic-release/semantic-release" rel="nofollow"> <img alt="semantic-release" src="https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg"> </a>
39-43: Markdown inside HTML div won’t render; convert to HTML and drop stylesGitHub does not parse Markdown within HTML blocks; inline styles are stripped.
-<div align="center" style="font-size: 2rem; font-weight: bolder;"> - -[Become a Sponsor!](https://github.com/sponsors/tannerlinsley/) - -</div> +<div align="center"> + <a href="https://github.com/sponsors/tannerlinsley/"><strong>Become a Sponsor!</strong></a> +</div>
78-91: Fix Start link target and remove inline styles across Ecosystem block
- TanStack Start incorrectly links to /router; should be /start.
- Remove inline styles; rely on default styling or .
-<div align="center"> -<a href="https://github.com/tanstack/config" style="font-weight: bold;">TanStack Config</a> – Tooling for JS/TS packages <br/> - <a href="https://github.com/tanstack/db" style="font-weight: bold;">TanStack DB</a> – Reactive sync client store <br/> - <a href="https://github.com/tanstack/devtools" style="font-weight: bold;">TanStack DevTools</a> – Unified devtools panel <br/> - <a href="https://github.com/tanstack/form" style="font-weight: bold;">TanStack Form</a> – Type‑safe form state <br/> - <a href="https://github.com/tanstack/pacer" style="font-weight: bold;">TanStack Pacer</a> – Debouncing, throttling, batching <br/> - <a href="https://github.com/tanstack/ranger" style="font-weight: bold;">TanStack Ranger</a> – Range & slider primitives <br/> - <a href="https://github.com/tanstack/router" style="font-weight: bold;">TanStack Router</a> – Type‑safe routing, caching & URL state<br/> - <a href="https://github.com/tanstack/router" style="font-weight: bold;">TanStack Start</a> – Full‑stack SSR & streaming<br/> - <a href="https://github.com/tanstack/store" style="font-weight: bold;">TanStack Store</a> – Reactive data store <br/> - <a href="https://github.com/tanstack/table" style="font-weight: bold;">TanStack Table</a> – Headless datagrids <br/> - <a href="https://github.com/tanstack/virtual" style="font-weight: bold;">TanStack Virtual</a> – Virtualized rendering <br/> - … and more at <a href="https://tanstack.com" style="font-weight: bold;">TanStack.com »</a> +<div align="center"> +<a href="https://github.com/tanstack/config"><strong>TanStack Config</strong></a> – Tooling for JS/TS packages <br/> + <a href="https://github.com/tanstack/db"><strong>TanStack DB</strong></a> – Reactive sync client store <br/> + <a href="https://github.com/tanstack/devtools"><strong>TanStack DevTools</strong></a> – Unified devtools panel <br/> + <a href="https://github.com/tanstack/form"><strong>TanStack Form</strong></a> – Type‑safe form state <br/> + <a href="https://github.com/tanstack/pacer"><strong>TanStack Pacer</strong></a> – Debouncing, throttling, batching <br/> + <a href="https://github.com/tanstack/ranger"><strong>TanStack Ranger</strong></a> – Range & slider primitives <br/> + <a href="https://github.com/tanstack/router"><strong>TanStack Router</strong></a> – Type‑safe routing, caching & URL state<br/> + <a href="https://github.com/tanstack/start"><strong>TanStack Start</strong></a> – Full‑stack SSR & streaming<br/> + <a href="https://github.com/tanstack/store"><strong>TanStack Store</strong></a> – Reactive data store <br/> + <a href="https://github.com/tanstack/table"><strong>TanStack Table</strong></a> – Headless datagrids <br/> + <a href="https://github.com/tanstack/virtual"><strong>TanStack Virtual</strong></a> – Virtualized rendering <br/> + … and more at <a href="https://tanstack.com"><strong>TanStack.com »</strong></a> </div>
🧹 Nitpick comments (2)
README.md (2)
14-16: Remove inline style; use semantic bold for Docs linkGitHub strips most inline styles. Prefer strong.
-<a href="https://tanstack.com/query" style="font-weight: bold">Read the Query Docs →</a> +<a href="https://tanstack.com/query"><strong>Read the Query Docs →</strong></a>
56-74: Inline styles likely stripped; simplify Partners wrapperGitHub sanitizes style attributes; layout is fine without them.
-<div style="display: flex; flex-wrap: wrap; gap: 50px; justify-content: center; align-items: center;"> +<div>
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(2 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
README.md
4-4: Images should have alternate text (alt text)
(MD045, no-alt-text)
🔇 Additional comments (1)
README.md (1)
7-13: LGTM: succinct feature bulletsClear, scannable, and accurate.
|
View your CI Pipeline Execution ↗ for commit 14a542c
☁️ Nx Cloud last updated this comment at |
TkDodo
reviewed
Sep 11, 2025
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (5)
README.md (5)
7-7: Avoid calling Query a “data‑fetching library”; use async state management wording.This aligns with how the project is positioned (async state + server‑state utilities; not tied to fetching only).
-A data‑fetching library built to simplify fetching, caching, synchronizing, and updating server state. +Powerful asynchronous state management, server‑state utilities, and data fetching. Fetch, cache, update, and wrangle async data in your JS/TS, React, Vue, Solid, Svelte & Angular apps without touching "global state".
19-28: Duplicate alt attributes and unsupported target attributes on badges.Keep one meaningful alt; remove target="…".
-<a href="https://www.npmjs.com/package/@tanstack/query-core" target="\_parent"> - <img alt="" src="https://img.shields.io/npm/dm/@tanstack/query-core.svg" alt="npm downloads" /> +<a href="https://www.npmjs.com/package/@tanstack/query-core"> + <img alt="npm downloads" src="https://img.shields.io/npm/dm/@tanstack/query-core.svg" /> </a> - <a href="https://github.com/TanStack/query/" target="\_parent"> - <img alt="" src="https://img.shields.io/github/stars/TanStack/query.svg?style=social&label=Star" alt="GitHub stars" /> + <a href="https://github.com/TanStack/query/"> + <img alt="GitHub stars" src="https://img.shields.io/github/stars/TanStack/query.svg?style=social&label=Star" /> </a> -<a href="https://bundlejs.com/?q=%40tanstack%2Freact-query&config=%7B%22esbuild%22%3A%7B%22external%22%3A%5B%22react%22%2C%22react-dom%22%5D%7D%7D&badge=" target="\_parent"> - <img alt="" src="https://deno.bundlejs.com/?q=@tanstack/react-query&config={%22esbuild%22:{%22external%22:[%22react%22,%22react-dom%22]}}&badge=detailed" alt="Bundle size" /> +<a href="https://bundlejs.com/?q=%40tanstack%2Freact-query&config=%7B%22esbuild%22%3A%7B%22external%22%3A%5B%22react%22%2C%22react-dom%22%5D%7D%7D&badge="> + <img alt="Bundle size" src="https://deno.bundlejs.com/?q=@tanstack/react-query&config={%22esbuild%22:{%22external%22:[%22react%22,%22react-dom%22]}}&badge=detailed" /> </a>
32-34: Broken semantic‑release badge link (href="#badge").Link to the project/docs instead.
-<a href="#badge"> +<a href="https://github.com/semantic-release/semantic-release" rel="nofollow"> <img alt="semantic-release" src="https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg"> </a>
39-43: Markdown inside HTML block won’t render on GitHub.Use an HTML anchor or move the link outside the div.
-<div align="center" style="font-size: 2rem; font-weight: bolder;"> - -[Become a Sponsor!](https://github.com/sponsors/tannerlinsley/) - -</div> +<div align="center"><a href="https://github.com/sponsors/tannerlinsley/"><strong>Become a Sponsor!</strong></a></div>
78-91: Fix Start link and remove inline styles across Ecosystem block.DevTools is correct; Start should point to tanstack/start. Also drop style="font-weight: bold;".
-<div align="center"> -<a href="https://github.com/tanstack/config" style="font-weight: bold;">TanStack Config</a> – Tooling for JS/TS packages <br/> - <a href="https://github.com/tanstack/db" style="font-weight: bold;">TanStack DB</a> – Reactive sync client store <br/> - <a href="https://github.com/tanstack/devtools" style="font-weight: bold;">TanStack DevTools</a> – Unified devtools panel <br/> - <a href="https://github.com/tanstack/form" style="font-weight: bold;">TanStack Form</a> – Type‑safe form state <br/> - <a href="https://github.com/tanstack/pacer" style="font-weight: bold;">TanStack Pacer</a> – Debouncing, throttling, batching <br/> - <a href="https://github.com/tanstack/ranger" style="font-weight: bold;">TanStack Ranger</a> – Range & slider primitives <br/> - <a href="https://github.com/tanstack/router" style="font-weight: bold;">TanStack Router</a> – Type‑safe routing, caching & URL state<br/> - <a href="https://github.com/tanstack/router" style="font-weight: bold;">TanStack Start</a> – Full‑stack SSR & streaming<br/> - <a href="https://github.com/tanstack/store" style="font-weight: bold;">TanStack Store</a> – Reactive data store <br/> - <a href="https://github.com/tanstack/table" style="font-weight: bold;">TanStack Table</a> – Headless datagrids <br/> - <a href="https://github.com/tanstack/virtual" style="font-weight: bold;">TanStack Virtual</a> – Virtualized rendering <br/> - … and more at <a href="https://tanstack.com" style="font-weight: bold;">TanStack.com »</a> +<div align="center"> +<a href="https://github.com/tanstack/config"><strong>TanStack Config</strong></a> – Tooling for JS/TS packages <br/> + <a href="https://github.com/tanstack/db"><strong>TanStack DB</strong></a> – Reactive sync client store <br/> + <a href="https://github.com/tanstack/devtools"><strong>TanStack DevTools</strong></a> – Unified devtools panel <br/> + <a href="https://github.com/tanstack/form"><strong>TanStack Form</strong></a> – Type‑safe form state <br/> + <a href="https://github.com/tanstack/pacer"><strong>TanStack Pacer</strong></a> – Debouncing, throttling, batching <br/> + <a href="https://github.com/tanstack/ranger"><strong>TanStack Ranger</strong></a> – Range & slider primitives <br/> + <a href="https://github.com/tanstack/router"><strong>TanStack Router</strong></a> – Type‑safe routing, caching & URL state<br/> + <a href="https://github.com/tanstack/start"><strong>TanStack Start</strong></a> – Full‑stack SSR & streaming<br/> + <a href="https://github.com/tanstack/store"><strong>TanStack Store</strong></a> – Reactive data store <br/> + <a href="https://github.com/tanstack/table"><strong>TanStack Table</strong></a> – Headless datagrids <br/> + <a href="https://github.com/tanstack/virtual"><strong>TanStack Virtual</strong></a> – Virtualized rendering <br/> + … and more at <a href="https://tanstack.com"><strong>TanStack.com »</strong></a> </div>
🧹 Nitpick comments (3)
README.md (3)
14-16: Remove inline styles; GitHub strips style attributes in READMEs.Use semantic HTML/Markdown for emphasis and spacing.
-<a href="https://tanstack.com/query" style="font-weight: bold">Read the Query Docs →</a> -<br /> +<p><a href="https://tanstack.com/query"><strong>Read the Query Docs →</strong></a></p>
17-17: Drop flex inline styles; they won’t render on GitHub.-<div align="center" style="display: flex; gap: 10px; flex-direction: column; justify-content: center;"> +<div align="center">
56-56: Inline styles in Partners section are stripped by GitHub.Use simple centered block without style attributes.
-<div style="display: flex; flex-wrap: wrap; gap: 50px; justify-content: center; align-items: center;"> +<div align="center">
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(2 hunks)
🔇 Additional comments (1)
README.md (1)
3-5: media/header_query.png present — no action required.
Confirmed file exists at repo root; README header image will render.
Co-authored-by: Sarah <[email protected]>
Contributor
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (4)
README.md (4)
20-28: Remove target attributes and duplicate alt attributes in badgesTargets are stripped by GitHub; each img should have a single, meaningful alt.
-<a href="https://www.npmjs.com/package/@tanstack/query-core" target="\_parent"> - <img alt="" src="https://img.shields.io/npm/dm/@tanstack/query-core.svg" alt="npm downloads" /> +<a href="https://www.npmjs.com/package/@tanstack/query-core"> + <img alt="npm downloads" src="https://img.shields.io/npm/dm/@tanstack/query-core.svg" /> </a> - <a href="https://github.com/TanStack/query/" target="\_parent"> - <img alt="" src="https://img.shields.io/github/stars/TanStack/query.svg?style=social&label=Star" alt="GitHub stars" /> + <a href="https://github.com/TanStack/query/"> + <img alt="GitHub stars" src="https://img.shields.io/github/stars/TanStack/query.svg?style=social&label=Star" /> </a> -<a href="https://bundlejs.com/?q=%40tanstack%2Freact-query&config=%7B%22esbuild%22%3A%7B%22external%22%3A%5B%22react%22%2C%22react-dom%22%5D%7D%7D&badge=" target="\_parent"> - <img alt="" src="https://deno.bundlejs.com/?q=@tanstack/react-query&config={%22esbuild%22:{%22external%22:[%22react%22,%22react-dom%22]}}&badge=detailed" alt="Bundle size" /> +<a href="https://bundlejs.com/?q=%40tanstack%2Freact-query&config=%7B%22esbuild%22%3A%7B%22external%22%3A%5B%22react%22%2C%22react-dom%22%5D%7D%7D&badge="> + <img alt="Bundle size" src="https://deno.bundlejs.com/?q=@tanstack/react-query&config={%22esbuild%22:{%22external%22:[%22react%22,%22react-dom%22]}}&badge=detailed" /> </a>
31-37: Fix broken semantic-release badge linkhref="#badge" points nowhere; link to the project/docs.
-<a href="#badge"> +<a href="https://github.com/semantic-release/semantic-release" rel="nofollow"> <img alt="semantic-release" src="https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg"> </a>
39-43: Markdown inside styled div won’t render as expectedReplace with plain HTML anchor; styles are stripped anyway.
-<div align="center" style="font-size: 2rem; font-weight: bolder;"> - -[Become a Sponsor!](https://github.com/sponsors/tannerlinsley/) - -</div> +<div align="center"> + <a href="https://github.com/sponsors/tannerlinsley/"><strong>Become a Sponsor!</strong></a> +</div>
76-91: Fix Start repo link and remove inline bold styles across EcosystemLink “TanStack Start” to the correct repo and drop style="font-weight: bold;" which is stripped.
-<div align="center"> -<a href="https://github.com/tanstack/config" style="font-weight: bold;">TanStack Config</a> – Tooling for JS/TS packages <br/> - <a href="https://github.com/tanstack/db" style="font-weight: bold;">TanStack DB</a> – Reactive sync client store <br/> - <a href="https://github.com/tanstack/devtools" style="font-weight: bold;">TanStack DevTools</a> – Unified devtools panel <br/> - <a href="https://github.com/tanstack/form" style="font-weight: bold;">TanStack Form</a> – Type‑safe form state <br/> - <a href="https://github.com/tanstack/pacer" style="font-weight: bold;">TanStack Pacer</a> – Debouncing, throttling, batching <br/> - <a href="https://github.com/tanstack/ranger" style="font-weight: bold;">TanStack Ranger</a> – Range & slider primitives <br/> - <a href="https://github.com/tanstack/router" style="font-weight: bold;">TanStack Router</a> – Type‑safe routing, caching & URL state<br/> - <a href="https://github.com/tanstack/router" style="font-weight: bold;">TanStack Start</a> – Full‑stack SSR & streaming<br/> - <a href="https://github.com/tanstack/store" style="font-weight: bold;">TanStack Store</a> – Reactive data store <br/> - <a href="https://github.com/tanstack/table" style="font-weight: bold;">TanStack Table</a> – Headless datagrids <br/> - <a href="https://github.com/tanstack/virtual" style="font-weight: bold;">TanStack Virtual</a> – Virtualized rendering <br/> - … and more at <a href="https://tanstack.com" style="font-weight: bold;">TanStack.com »</a> +<div align="center"> +<a href="https://github.com/tanstack/config">TanStack Config</a> – Tooling for JS/TS packages <br/> + <a href="https://github.com/tanstack/db">TanStack DB</a> – Reactive sync client store <br/> + <a href="https://github.com/tanstack/devtools">TanStack DevTools</a> – Unified devtools panel <br/> + <a href="https://github.com/tanstack/form">TanStack Form</a> – Type‑safe form state <br/> + <a href="https://github.com/tanstack/pacer">TanStack Pacer</a> – Debouncing, throttling, batching <br/> + <a href="https://github.com/tanstack/ranger">TanStack Ranger</a> – Range & slider primitives <br/> + <a href="https://github.com/tanstack/router">TanStack Router</a> – Type‑safe routing, caching & URL state<br/> + <a href="https://github.com/tanstack/start">TanStack Start</a> – Full‑stack SSR & streaming<br/> + <a href="https://github.com/tanstack/store">TanStack Store</a> – Reactive data store <br/> + <a href="https://github.com/tanstack/table">TanStack Table</a> – Headless datagrids <br/> + <a href="https://github.com/tanstack/virtual">TanStack Virtual</a> – Virtualized rendering <br/> + … and more at <a href="https://tanstack.com">TanStack.com »</a>Quick check:
#!/usr/bin/env bash rg -n 'https://github.com/tanstack/router"|https://github.com/tanstack/start' -n -C0 README.md
🧹 Nitpick comments (3)
README.md (3)
14-16: Use Markdown link; drop unsupported style/brGitHub strips inline styles; the
isn’t needed here. Use plain Markdown.-<a href="https://tanstack.com/query" style="font-weight: bold">Read the Query Docs →</a> -<br /> +[Read the Query Docs →](https://tanstack.com/query)
17-17: Inline flex styles are stripped by GitHubThe layout won’t apply. Remove style= and keep simple blocks.
-<div align="center" style="display: flex; gap: 10px; flex-direction: column; justify-content: center;"> +<div align="center">
56-74: Strip inline styles from Partners wrapperGitHub sanitizes style=. Keep the container simple; alignment can use align="center" if needed.
-<div style="display: flex; flex-wrap: wrap; gap: 50px; justify-content: center; align-items: center;"> +<div align="center">
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(2 hunks)
🔇 Additional comments (3)
README.md (3)
7-13: LGTM: concise positioning + capabilitiesThe description and bullets align with our messaging and prior guidance.
49-52: LGTM: community calls-to-actionClear and helpful links for issues, discussions, Discord, and contributing.
3-5: Relative README hero image: file present — prefer absolute URL or ensure media is published
- media/header_query.png is present in the repo (OK). If the package published to npm excludes media the README hero can 404 — either use an absolute URL (e.g. https://raw.githubusercontent.com/TanStack/query/main/media/header_query.png) or ensure the image is included in the published package (package.json "files" / .npmignore).
- README gotchas found: inline style= attributes (lines 14, 17, 39, 56, 79–90), target= attributes (lines 20, 23, 26), and duplicate alt attributes on
tags (lines 21, 24, 27). Remove duplicate alts and avoid/adjust inline styles/target where possible.
Merged
Hellol77
pushed a commit
to Hellol77/query
that referenced
this pull request
Oct 14, 2025
* readme updates * fix devtools link * Apply suggestion from @coderabbitai[bot] Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Update README.md Co-authored-by: Sarah <[email protected]> --------- Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Co-authored-by: Dominik Dorfmeister <[email protected]>
4 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary:
Note: The image is currently a relative link and I see the previous ones aren't so that might need to be updated.
Summary by CodeRabbit