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

sukvvon · 2026-08-16T09:18:49Z

🎯 Changes

The Angular API Reference sidebar (docs/config.json) only linked to 2 of the 16 functions that actually exist under docs/framework/angular/reference/functions/ (generated via pnpm run generate-docs). The rest were reachable only by direct URL, not from the sidebar.

Register the 12 missing, non-deprecated functions: infiniteQueryOptions, injectInfiniteQuery, injectIsFetching, injectIsMutating, injectIsRestoring, injectMutationState, mutationOptions, provideIsRestoring, provideQueryClient, provideTanStackQuery, queryFeature, queryOptions
Follow the existing local label convention (Functions / <name>) already used by the two pre-existing entries
Intentionally skip injectQueryClient and provideAngularQuery — both are marked @deprecated in source (in favor of inject(QueryClient) and provideTanStackQuery respectively) and shown struck through in framework/angular/reference/index.md
Interfaces / Type Aliases pages are left out of the sidebar, consistent with how Preact, Svelte, and Lit's generated reference docs are registered (functions only)

✅ 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
- Expanded the Angular API Reference navigation with additional entries for query options, infinite queries, mutations, injection helpers, query clients, and query features.

…n sidebar

coderabbitai · 2026-08-16T09:19:07Z

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: 830c097c-40d3-4b04-b39a-27dde6b1f1e9

📥 Commits

Reviewing files that changed from the base of the PR and between a9f416b and 1b05325.

📒 Files selected for processing (1)

docs/config.json

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

📝 Walkthrough

Walkthrough

The Angular API Reference navigation now includes entries for infinite query options, injection helpers, mutation and query state helpers, options, query-client providers, and queryFeature.

Changes

Angular API Reference Navigation

Layer / File(s)	Summary
Add Angular API navigation entries `docs/config.json`	Adds navigation entries for Angular query and mutation options, injection helpers, state helpers, query-client providers, and `queryFeature`.

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

Merge Risk:⚪ Minimal · up to 1b053

This documentation-only change adds missing Angular API functions to the sidebar without affecting published code or runtime behavior. No actionable merge-blocking risk remains beyond normal review.

Possibly related PRs

TanStack/query#11189: Both PRs update Angular API Reference navigation for related query and mutation APIs.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly identifies the documentation configuration change and the missing Angular API reference functions.
Description check	✅ Passed	The description includes all template sections and clearly explains the sidebar additions, exclusions, testing status, and release impact.
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-angular-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:19:19Z

View your CI Pipeline Execution ↗ for commit 1b05325

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

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

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

🚀 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:22:33Z

More templates

@tanstack/angular-query-experimental

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

@tanstack/eslint-plugin-query

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

@tanstack/lit-query

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

@tanstack/preact-query

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

@tanstack/preact-query-devtools

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

@tanstack/preact-query-persist-client

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

@tanstack/query-async-storage-persister

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

@tanstack/query-broadcast-client-experimental

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

@tanstack/query-core

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

@tanstack/query-devtools

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

@tanstack/query-persist-client-core

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

@tanstack/query-sync-storage-persister

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

@tanstack/react-query

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

@tanstack/react-query-devtools

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

@tanstack/react-query-next-experimental

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

@tanstack/react-query-persist-client

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

@tanstack/solid-query

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

@tanstack/solid-query-devtools

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

@tanstack/solid-query-persist-client

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

@tanstack/svelte-query

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

@tanstack/svelte-query-devtools

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

@tanstack/svelte-query-persist-client

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

@tanstack/vue-query

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

@tanstack/vue-query-devtools

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

commit: 1b05325

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

size-limit report 📦

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

docs(config.json): register missing angular API reference functions i…
1b05325
…n sidebar

sukvvon self-assigned this Aug 16, 2026

sukvvon merged commit 7d4b6ed into mainAug 16, 2026
9 checks passed

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

Navigation Menu

Uh oh!

Uh oh!

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

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

sukvvon commented Aug 16, 2026•
edited by coderabbitai Bot
Loading

Uh oh!

coderabbitaiBot commented Aug 16, 2026•
edited
Loading

Walkthrough

Changes

Uh oh!

nx-cloudBot commented Aug 16, 2026•
edited
Loading

Uh oh!

github-actionsBot commented Aug 16, 2026

Uh oh!

pkg-pr-newBot commented Aug 16, 2026

Uh oh!

github-actionsBot 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 BotLoading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🎯 Changes

✅ Checklist

🚀 Release Impact

Summary by CodeRabbit

Uh oh!

coderabbitaiBot 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-cloudBot commented Aug 16, 2026• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actionsBot commented Aug 16, 2026

🚀 Changeset Version Preview

Uh oh!

pkg-pr-newBot commented Aug 16, 2026

Uh oh!

github-actionsBot 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

coderabbitaiBot commented Aug 16, 2026•
edited
Loading

nx-cloudBot commented Aug 16, 2026•
edited
Loading