docs(react): fix broken anchors in SSR and migration guides by pavan-sh · Pull Request #10214 · TanStack/query

pavan-sh · 2026-03-02T17:33:45Z

🎯 Changes

Fix broken internal anchor links in React docs.

While running the docs link checker, I found a few references pointing to anchors that don’t exist anymore (likely due to heading changes). This PR updates them to valid anchors and removes one stale anchor reference in the migration guide.

Changes included:

ssr.md: fix the “Dependent Queries & Code Splitting” anchor to match the actual heading slug (#dependent-queries-code-splitting)
ssr.md: add a direct link to that section near the top for easier discovery
migrating-to-react-query-4.md: fix the disabling-queries anchor and remove the stale #old-cancel-function anchor reference (link now points to the page, since that heading doesn’t exist)

✅ Checklist

I have followed the steps in the Contributing guide.
I have tested this code locally with pnpm run test:pr.

🚀 Release Impact

This change affects published code, and I have generated a changeset.
This change is docs/CI/dev-only (no release).

🧪 Test plan

pnpm install
pnpm test:docs

Summary by CodeRabbit

Documentation
- Updated cross-references and anchor links throughout guides for improved navigation
- Clarified migration guide information regarding API changes and deprecations
- Enhanced server-side rendering documentation with additional references to performance and prefetching patterns

changeset-bot · 2026-03-02T17:33:49Z

⚠️ No Changeset found

Latest commit: 211cd59

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

coderabbitai · 2026-03-02T17:33:59Z

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 0a4be156-3056-41ba-8c9c-8bde7d4f79ea

📥 Commits

Reviewing files that changed from the base of the PR and between dc66cc0 and 211cd59.

📒 Files selected for processing (1)

docs/framework/react/guides/ssr.md

📝 Walkthrough

Walkthrough

Corrected cross-reference anchors and wording in two React Query docs: updated an anchor in the migration guide and clarified removal of the old cancel method; in the SSR guide fixed link anchors, added a cross-reference to deeper hydration/prefetching examples, and updated a guide link.

Changes

Cohort / File(s)	Summary
Migration Guide `docs/framework/react/guides/migrating-to-react-query-4.md`	Fixed a cross-link anchor (`#isloading-previously-isinitialloading`) and reworded the description to state the old `cancel` method was removed and that the new AbortController-based API supplies an AbortSignal.
SSR Guide `docs/framework/react/guides/ssr.md`	Added a cross-reference to deeper hydration/prefetching examples, replaced a Request Waterfalls citation with a Performance & Request Waterfalls guide link, and corrected prefetched dependent-queries anchors (changed `dependent-queries--code-splitting` to `dependent-queries-code-splitting`).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~5 minutes

Possibly related PRs

docs(react): fix broken anchors in SSR and migration guides #10214: Edits the same documentation files and fixes identical broken anchors and wording around the removed cancel API.
docs: correct local relative links #9947: Similar anchor and cross-link corrections in the same React docs (migrating-to-react-query-4.md, ssr.md).

Poem

🐰 I hopped through docs with tiny feet,

Fixed the links so pages meet,
Cancelled cancel — now Abort leads,
Signals sent for fetching deeds,
Hooray — the guides are tidy and neat! ✨

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately describes the main change: fixing broken anchors in documentation files (SSR and migration guides).
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description check	✅ Passed	The pull request description is comprehensive and follows the template structure with all required sections completed.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment

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 and usage tips.}

nx-cloud · 2026-03-02T17:34:33Z

View your CI Pipeline Execution ↗ for commit 211cd59

Command	Status	Duration	Result
`nx run-many --target=build --exclude=examples/*...`	✅ Succeeded	<1s	View ↗
`nx affected --targets=test:sherif,test:knip,tes...`	✅ Succeeded	30s	View ↗

☁️ Nx Cloud last updated this comment at 2026-03-04 12:48:15 UTC

pkg-pr-new · 2026-03-02T17:35:36Z

More templates

@tanstack/angular-query-experimental

npm i https://pkg.pr.new/@tanstack/angular-query-experimental@10214

@tanstack/eslint-plugin-query

npm i https://pkg.pr.new/@tanstack/eslint-plugin-query@10214

@tanstack/preact-query

npm i https://pkg.pr.new/@tanstack/preact-query@10214

@tanstack/preact-query-devtools

npm i https://pkg.pr.new/@tanstack/preact-query-devtools@10214

@tanstack/preact-query-persist-client

npm i https://pkg.pr.new/@tanstack/preact-query-persist-client@10214

@tanstack/query-async-storage-persister

npm i https://pkg.pr.new/@tanstack/query-async-storage-persister@10214

@tanstack/query-broadcast-client-experimental

npm i https://pkg.pr.new/@tanstack/query-broadcast-client-experimental@10214

@tanstack/query-core

npm i https://pkg.pr.new/@tanstack/query-core@10214

@tanstack/query-devtools

npm i https://pkg.pr.new/@tanstack/query-devtools@10214

@tanstack/query-persist-client-core

npm i https://pkg.pr.new/@tanstack/query-persist-client-core@10214

@tanstack/query-sync-storage-persister

npm i https://pkg.pr.new/@tanstack/query-sync-storage-persister@10214

@tanstack/react-query

npm i https://pkg.pr.new/@tanstack/react-query@10214

@tanstack/react-query-devtools

npm i https://pkg.pr.new/@tanstack/react-query-devtools@10214

@tanstack/react-query-next-experimental

npm i https://pkg.pr.new/@tanstack/react-query-next-experimental@10214

@tanstack/react-query-persist-client

npm i https://pkg.pr.new/@tanstack/react-query-persist-client@10214

@tanstack/solid-query

npm i https://pkg.pr.new/@tanstack/solid-query@10214

@tanstack/solid-query-devtools

npm i https://pkg.pr.new/@tanstack/solid-query-devtools@10214

@tanstack/solid-query-persist-client

npm i https://pkg.pr.new/@tanstack/solid-query-persist-client@10214

@tanstack/svelte-query

npm i https://pkg.pr.new/@tanstack/svelte-query@10214

@tanstack/svelte-query-devtools

npm i https://pkg.pr.new/@tanstack/svelte-query-devtools@10214

@tanstack/svelte-query-persist-client

npm i https://pkg.pr.new/@tanstack/svelte-query-persist-client@10214

@tanstack/vue-query

npm i https://pkg.pr.new/@tanstack/vue-query@10214

@tanstack/vue-query-devtools

npm i https://pkg.pr.new/@tanstack/vue-query-devtools@10214

commit: ec03e15

docs/framework/react/guides/ssr.md

docs(react): fix broken anchors in SSR and migration guides

dc66cc0

github-actions bot added the documentation Improvements or additions to documentation label Mar 2, 2026

TkDodo reviewed Mar 4, 2026

View reviewed changes

docs/framework/react/guides/ssr.md Outdated Show resolved Hide resolved

Update docs/framework/react/guides/ssr.md

211cd59

TkDodo merged commit fe25edc into TanStack:main Mar 4, 2026
5 of 6 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

docs(react): fix broken anchors in SSR and migration guides#10214

docs(react): fix broken anchors in SSR and migration guides#10214
TkDodo merged 2 commits intoTanStack:mainfrom
pavan-sh:docs/snippet-fixes-and-anchors

pavan-sh commented Mar 2, 2026 •

edited by coderabbitai bot

Loading

Uh oh!

changeset-bot bot commented Mar 2, 2026 •

edited

Loading

Uh oh!

coderabbitai bot commented Mar 2, 2026 •

edited

Loading

Review failed

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Poem

Uh oh!

nx-cloud bot commented Mar 2, 2026 •

edited

Loading

Uh oh!

pkg-pr-new bot commented Mar 2, 2026

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

pavan-sh commented Mar 2, 2026 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🎯 Changes

✅ Checklist

🚀 Release Impact

🧪 Test plan

Summary by CodeRabbit

Uh oh!

changeset-bot bot commented Mar 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

⚠️ No Changeset found

Uh oh!

coderabbitai bot commented Mar 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review failed

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Poem

Uh oh!

nx-cloud bot commented Mar 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pkg-pr-new bot commented Mar 2, 2026

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

pavan-sh commented Mar 2, 2026 •

edited by coderabbitai bot

Loading

changeset-bot bot commented Mar 2, 2026 •

edited

Loading

coderabbitai bot commented Mar 2, 2026 •

edited

Loading

nx-cloud bot commented Mar 2, 2026 •

edited

Loading