Skip to content

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

Open
pavan-sh wants to merge 1 commit intoTanStack:mainfrom
pavan-sh:docs/snippet-fixes-and-anchors
Open

docs(react): fix broken anchors in SSR and migration guides#10214
pavan-sh wants to merge 1 commit intoTanStack:mainfrom
pavan-sh:docs/snippet-fixes-and-anchors

Conversation

@pavan-sh
Copy link
Contributor

@pavan-sh pavan-sh commented Mar 2, 2026 •
edited
Loading

🎯 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

@changeset-bot
Copy link

changeset-bot bot commented Mar 2, 2026

⚠️ No Changeset found

Latest commit: dc66cc0

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
Copy link
Contributor

coderabbitai bot commented Mar 2, 2026 •
edited
Loading

📝 Walkthrough

Walkthrough

Documentation updates across two React Query guides: corrected cross-reference anchors in the migration guide and SSR documentation, reworded API description text, and added navigation cross-references for consistency and clarity.

Changes

Cohort / File(s) Summary
Migration Guide Updates
docs/framework/react/guides/migrating-to-react-query-4.md		 Updated cross-link anchor reference and reworded description of removed cancel method, clarifying the transition to AbortController-based API.
SSR Guide Corrections
docs/framework/react/guides/ssr.md		 Added hydration/prefetching cross-reference, updated guide references, and corrected link anchors in Prefetching sections (changed double-dash to single-dash format for consistency).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~5 minutes

Possibly related PRs

Suggested labels

documentation

Poem

🐰 Our docs now link with perfect grace,
Anchors fixed in their right place,
Cross-references dance hand-in-hand,
Clarity spreads throughout the land! ✨

🚥 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.

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Mar 2, 2026
@nx-cloud
Copy link

nx-cloud bot commented Mar 2, 2026 •
edited
Loading

View your CI Pipeline Execution ↗ for commit dc66cc0

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

☁️ Nx Cloud last updated this comment at 2026-03-02 17:35:45 UTC

@pkg-pr-new
Copy link

pkg-pr-new bot commented Mar 2, 2026

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

documentation Improvements or additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@pavan-sh