Readme fix #9652
Readme fix #9652
Conversation
WalkthroughREADME.md reorganized: updated intro to TanStack Query, refreshed feature list, reworked sponsor and partners sections, adjusted badges with alt text, replaced Speakeasy block with Code Rabbit and Cloudflare partners, added partner CTA, and simplified ecosystem exploration into linked entries. No code or API changes. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Possibly related PRs
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ 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 |
|
View your CI Pipeline Execution ↗ for commit f70c6b3
☁️ Nx Cloud last updated this comment at |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
README.md (4)
31-33: Avoid heading level jump before the main H1Using an H3 here creates non-sequential headings and noisy TOC. Prefer bold text or move this under the main H1.
Apply this diff:
-### [Become a Sponsor!](https://github.com/sponsors/tannerlinsley/) +**[Become a Sponsor!](https://github.com/sponsors/tannerlinsley/)**
44-44: Fix stray closing tag and heading level (MD001)There’s a dangling and a jump to H3 after H1. Recommend H2 and plain markdown link.
Apply this diff:
-### <a href="https://tanstack.com/query">Read the docs →</b></a> +## [Read the docs →](https://tanstack.com/query)
55-69: Remove unsupported HTML padding; GitHub sanitizes CSS/invalid attrs
padding="20px"onand
padding="20"on won’t render (invalid/stripped). Use tablecellpaddingor simplify layout.Apply this diff:
-<table align="center"> +<table align="center" cellpadding="10"> @@ - <img src="https://tanstack.com/assets/coderabbit-light-DVMJ2jHi.svg" height="40" padding="20px" alt="Code Rabbit"/> + <img src="https://tanstack.com/assets/coderabbit-light-DVMJ2jHi.svg" height="40" alt="Code Rabbit"/> @@ - <td padding="20"> + <td> <a href="https://www.cloudflare.com?utm_source=tanstack"> <img src="https://tanstack.com/assets/cloudflare-black-CPufaW0B.svg" height="70" alt="Cloudflare"/> </a> </td>
83-95: Fix incorrect link: “TanStack Start” points to Router repoLink should target the Start repo.
Apply this diff:
-- <a href="https://github.com/tanstack/router"><b>TanStack Start</b></a> – Full‑stack SSR & streaming +- <a href="https://github.com/tanstack/start"><b>TanStack Start</b></a> – Full‑stack SSR & streaming
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
media/partner_logo.svgis excluded by!**/*.svg
📒 Files selected for processing (1)
README.md(2 hunks)
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2025-09-02T17:57:33.184Z
Learnt from: TkDodo
PR: TanStack/query#9612
File: packages/query-async-storage-persister/src/asyncThrottle.ts:0-0
Timestamp: 2025-09-02T17:57:33.184Z
Learning: When importing from tanstack/query-core in other TanStack Query packages like query-async-storage-persister, a workspace dependency "tanstack/query-core": "workspace:*" needs to be added to the package.json.
Applied to files:
README.md
🪛 markdownlint-cli2 (0.17.2)
README.md
44-44: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3
(MD001, heading-increment)
🔇 Additional comments (3)
README.md (3)
23-27: Badges: improved accessibility looks goodAlt text additions/readability improvements are solid.
35-43: Intro and feature bullets read cleanClear, markdown-friendly copy. Good change.
71-77: Partner CTA block looks goodConcise copy and clear CTA.
Forgot about CSS sanitizing - updating README for that in mind.
Summary by CodeRabbit