Skip to content

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

Merged
sukvvon merged 1 commit into
mainfrom
docs/unify-svelte-angular-sidebar-labels
Aug 16, 2026
Merged

docs(config.json): drop redundant 'Functions /' prefix from svelte and angular sidebar labels#11193
sukvvon merged 1 commit into
mainfrom
docs/unify-svelte-angular-sidebar-labels

Conversation

@sukvvon

@sukvvon sukvvon commented Aug 16, 2026

Copy link
Copy Markdown
Member

🎯 Changes

The Svelte and Angular API Reference sidebars prefix every single function entry with Functions / (e.g. Functions / useQueryClient), while React, Vue, Solid, and Preact use bare labels (useQueryClient) for the same kind of entries. Since the prefix appears on 100% of the siblings in each of these two frameworks' lists, it distinguishes nothing and is pure visual noise.

  • Strip the Functions / prefix from all 12 Svelte entries and all 14 Angular entries
  • Leave the Svelte Reference / Angular Reference index entries untouched — those are the only sidebar path to the interfaces//type-aliases/ pages, so removing them would be a functional change, not cosmetic
  • Leave Lit untouched entirely — its Functions / and Context / prefixes aren't a mechanical reflection of the TypeDoc-generated folder structure; several Context /-prefixed entries actually live under functions/ on disk, meaning someone hand-grouped them by meaning. That grouping is intentional and shouldn't be flattened.
  • Precedent: Preact already ships a TypeDoc-generated reference/functions/* folder structure with bare sidebar labels, and TanStack Table's Svelte adapter (same generator) does the same (createTable, not Functions / createTable) — confirming this prefix is local drift in Query's config, not a house convention.

✅ 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 Svelte and Angular API reference navigation labels for clearer presentation.
    • Preserved all existing navigation routes and links.

@coderabbitai

coderabbitai Bot commented Aug 16, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

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: 8e81921f-4899-437e-a8f3-6d84b5959723

📥 Commits

Reviewing files that changed from the base of the PR and between 9ad475e and a7a4522.

📒 Files selected for processing (1)
  • docs/config.json

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


📝 Walkthrough

Walkthrough

The documentation configuration updates Svelte and Angular API-reference labels. The changes remove the Functions / prefix and preserve all destination paths.

Changes

API reference navigation

Layer / File(s) Summary
Update Svelte and Angular navigation labels
docs/config.json
Svelte and Angular function-reference entries now display function names directly. Their destination paths remain unchanged.

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

Merge Risk: ⚪ Minimal · up to a7a45

This localized documentation change removes redundant sidebar label prefixes for Svelte and Angular without changing published code or functionality; no actionable merge-blocking risk remains after normal checks and review.

Possibly related PRs

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the removal of the redundant prefix from Svelte and Angular sidebar labels.
Description check ✅ Passed The description explains the changes, scope, rationale, checklist status, and lack of 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/unify-svelte-angular-sidebar-labels

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

nx-cloud Bot commented Aug 16, 2026

Copy link
Copy Markdown

View your CI Pipeline Execution ↗ for commit a7a4522

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

☁️ Nx Cloud last updated this comment at 2026-08-16 10:11:11 UTC

@sukvvon sukvvon self-assigned this Aug 16, 2026
@github-actions

Copy link
Copy Markdown
Contributor

🚀 Changeset Version Preview

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

@pkg-pr-new

pkg-pr-new Bot commented Aug 16, 2026

Copy link
Copy Markdown
More templates

@tanstack/angular-query-experimental

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

@tanstack/eslint-plugin-query

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

@tanstack/lit-query

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

@tanstack/preact-query

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

@tanstack/preact-query-devtools

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

@tanstack/preact-query-persist-client

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

@tanstack/query-async-storage-persister

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

@tanstack/query-broadcast-client-experimental

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

@tanstack/query-core

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

@tanstack/query-devtools

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

@tanstack/query-persist-client-core

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

@tanstack/query-sync-storage-persister

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

@tanstack/react-query

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

@tanstack/react-query-devtools

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

@tanstack/react-query-next-experimental

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

@tanstack/react-query-persist-client

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

@tanstack/solid-query

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

@tanstack/solid-query-devtools

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

@tanstack/solid-query-persist-client

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

@tanstack/svelte-query

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

@tanstack/svelte-query-devtools

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

@tanstack/svelte-query-persist-client

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

@tanstack/vue-query

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

@tanstack/vue-query-devtools

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

commit: a7a4522

@github-actions

Copy link
Copy Markdown
Contributor

size-limit report 📦

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

@sukvvon
sukvvon merged commit 3f9d11b into main Aug 16, 2026
9 checks passed
@sukvvon
sukvvon deleted the docs/unify-svelte-angular-sidebar-labels branch August 16, 2026 10:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant