docs(config.json): register missing svelte API reference functions in sidebar by sukvvon · Pull Request #11192 · TanStack/query

sukvvon · 2026-08-16T09:42:17Z

🎯 Changes

The Svelte API Reference sidebar (docs/config.json) was missing links to two functions that exist under docs/framework/svelte/reference/functions/ (generated via pnpm run generate-docs) and are publicly exported from @tanstack/svelte-query:

useQueryClient — already registered for React, Vue, and Preact; Svelte was the outlier missing it
useHydrate — Svelte's function-based equivalent of the HydrationBoundary/hydration API that other frameworks expose in their reference docs

Other candidates found in the same gap analysis were intentionally excluded:

useIsRestoring — not registered in React's reference sidebar either; it's documented inline in the persistQueryClient plugin guide instead, which Svelte doesn't currently have
getQueryClientContext / setQueryClientContext / getIsRestoringContext / setIsRestoringContext — internal plumbing used by useQueryClient and QueryClientProvider.svelte themselves, not user-facing APIs, with no usage in any guide or plugin doc

Neither of the two added functions is marked @deprecated in source or struck through in framework/svelte/reference/index.md.

✅ Checklist

I have followed the steps in the Contributing guide.
I have tested this code locally with pnpm run test:pr. (docs-only change, no code/tests affected)

🚀 Release Impact

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

Summary by CodeRabbit

Documentation
- Updated the Svelte API reference navigation to include useQueryClient and useHydrate.

… sidebar

coderabbitai · 2026-08-16T09:42:35Z

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 5ea78c34-2392-4777-a503-1d86a006835f

📥 Commits

Reviewing files that changed from the base of the PR and between 7d4b6ed and e4c58e7.

📒 Files selected for processing (1)

docs/config.json

Included review availability: Your plan includes up to 10 reviews per rolling hour; 8 remain after this review.

📝 Walkthrough

Walkthrough

The Svelte API reference navigation now includes entries for useQueryClient and useHydrate.

Changes

Svelte API navigation

Layer / File(s)	Summary
Add Svelte API reference entries `docs/config.json`	Adds navigation entries for `useQueryClient` and `useHydrate`.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Merge Risk: ⚪ Minimal · up to e4c58

This localized documentation change adds missing Svelte API reference links without changing published code or runtime behavior; no actionable merge-blocking risk remains.

Possibly related PRs

TanStack/query#11189: Updates Svelte API reference navigation with additional entries and generated documentation.
TanStack/query#11191: Registers missing framework API reference entries in docs/config.json.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly and concisely describes the missing Svelte API reference sidebar registrations.
Description check	✅ Passed	The description includes the required Changes, Checklist, and Release Impact sections with relevant details and completed selections.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch docs/register-svelte-api-reference-sidebar

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

nx-cloud · 2026-08-16T09:42:49Z

View your CI Pipeline Execution ↗ for commit e4c58e7

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

☁️ Nx Cloud last updated this comment at 2026-08-16 09:46:02 UTC

github-actions · 2026-08-16T09:43:19Z

🚀 Changeset Version Preview

No changeset entries found. Merging this PR will not cause a version bump for any packages.

pkg-pr-new · 2026-08-16T09:45:50Z

More templates

@tanstack/angular-query-experimental

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

@tanstack/eslint-plugin-query

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

@tanstack/lit-query

npm i https://pkg.pr.new/@tanstack/lit-query@11192

@tanstack/preact-query

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

@tanstack/preact-query-devtools

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

@tanstack/preact-query-persist-client

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

@tanstack/query-async-storage-persister

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

@tanstack/query-broadcast-client-experimental

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

@tanstack/query-core

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

@tanstack/query-devtools

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

@tanstack/query-persist-client-core

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

@tanstack/query-sync-storage-persister

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

@tanstack/react-query

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

@tanstack/react-query-devtools

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

@tanstack/react-query-next-experimental

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

@tanstack/react-query-persist-client

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

@tanstack/solid-query

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

@tanstack/solid-query-devtools

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

@tanstack/solid-query-persist-client

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

@tanstack/svelte-query

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

@tanstack/svelte-query-devtools

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

@tanstack/svelte-query-persist-client

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

@tanstack/vue-query

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

@tanstack/vue-query-devtools

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

commit: e4c58e7

github-actions · 2026-08-16T09:46:03Z

size-limit report 📦

Path	Size
react full	12.15 KB (0%)
react minimal	9.1 KB (0%)

docs(config.json): register missing svelte API reference functions in…

e4c58e7

… sidebar

sukvvon self-assigned this Aug 16, 2026

sukvvon merged commit 9ad475e into main Aug 16, 2026
9 checks passed

sukvvon deleted the docs/register-svelte-api-reference-sidebar branch August 16, 2026 09:49

This was referenced Aug 16, 2026

docs(config.json): drop redundant 'Functions /' prefix from svelte and angular sidebar labels #11193

Merged

docs(config.json): add 'Preact Reference' index entry to API Reference sidebar #11198

Merged

Navigation Menu

Uh oh!

Uh oh!

docs(config.json): register missing svelte API reference functions in sidebar - #11192

docs(config.json): register missing svelte API reference functions in sidebar#11192
sukvvon merged 1 commit into
mainfrom
docs/register-svelte-api-reference-sidebar

sukvvon commented Aug 16, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

coderabbitai Bot commented Aug 16, 2026 •

edited

Loading

Walkthrough

Changes

Uh oh!

nx-cloud Bot commented Aug 16, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Aug 16, 2026

Uh oh!

pkg-pr-new Bot commented Aug 16, 2026

Uh oh!

github-actions Bot commented Aug 16, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Uh oh!

Uh oh!

Conversation

sukvvon commented Aug 16, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🎯 Changes

✅ Checklist

🚀 Release Impact

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented Aug 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Uh oh!

nx-cloud Bot commented Aug 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Aug 16, 2026

🚀 Changeset Version Preview

Uh oh!

pkg-pr-new Bot commented Aug 16, 2026

Uh oh!

github-actions Bot commented Aug 16, 2026

size-limit report 📦

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

sukvvon commented Aug 16, 2026 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Aug 16, 2026 •

edited

Loading

nx-cloud Bot commented Aug 16, 2026 •

edited

Loading