Skip to content

docs(config): register redirect_from mappings for vue-query reference pages - #11398

Open
sukvvon wants to merge 2 commits into
mainfrom
docs/vue-query-redirect-from
Open

docs(config): register redirect_from mappings for vue-query reference pages#11398
sukvvon wants to merge 2 commits into
mainfrom
docs/vue-query-redirect-from

Conversation

@sukvvon

@sukvvon sukvvon commented Sep 5, 2026

Copy link
Copy Markdown
Member

🎯 Changes

PR #11378 switched docs/framework/vue/reference/ from 14 hand-written flat files to TypeDoc-generated output under functions/, deleting the old flat URLs. Same as the react (#11379) and solid migrations, this registers redirectFrom mappings in scripts/generate-docs.ts's vue-query entry so the old URLs 301 to their new locations instead of 404ing.

  • Added redirectFrom for the 13 functions that map 1:1 to a new functions/ page (infiniteQueryOptions, mutationOptions, queryOptions, useInfiniteQuery, useIsFetching, useIsMutating, useMutation, useMutationState, usePrefetchInfiniteQuery, usePrefetchQuery, useQueries, useQuery, useQueryClient).
  • hydration.md has no direct replacement — its content was folded into guides/ssr.md's new "dehydrate/hydrate options" subsection in docs(vue-query): add JSDoc and generate reference docs with TypeDoc #11378, so redirect_from: - framework/vue/reference/hydration was added directly to ssr.md's frontmatter instead (same pattern as react's guides/ssr.md).
  • Ran pnpm run generate-docs to regenerate the 13 reference pages with the new redirect_from frontmatter.

Checked for duplicate redirect_from sources across all of docs/ before adding (a duplicate from pointing at different to targets breaks the site-wide redirect manifest build) — none found.

✅ Checklist

  • I have followed the steps in the Contributing guide.
  • I have tested code changes locally with pnpm run test:pr, or these tests do not apply to this pull request.
  • I fully understand the code in this pull request, including any code generated with AI assistance.

🚀 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
    • Added redirects from legacy Vue documentation URLs to their current reference pages.
    • Preserved access to moved query, mutation, prefetch, and QueryClient documentation.
    • Added a redirect from the former hydration reference URL to the SSR guide.

@sukvvon
sukvvon requested a review from a team as a code owner September 5, 2026 04:33
@sukvvon
sukvvon requested a review from TkDodo September 5, 2026 04:34
@sukvvon sukvvon self-assigned this Sep 5, 2026
@nx-cloud

nx-cloud Bot commented Sep 5, 2026

Copy link
Copy Markdown

View your CI Pipeline Execution ↗ for commit 9dd0a7a

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

☁️ Nx Cloud last updated this comment at 2026-09-05 04:47:46 UTC

@coderabbitai

coderabbitai Bot commented Sep 5, 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: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Team

Run ID: 84caf336-7556-4e8b-a04c-f1e390dc9abb

📥 Commits

Reviewing files that changed from the base of the PR and between 3095086 and 9dd0a7a.

📒 Files selected for processing (15)
  • docs/framework/vue/guides/ssr.md
  • docs/framework/vue/reference/functions/infiniteQueryOptions.md
  • docs/framework/vue/reference/functions/mutationOptions.md
  • docs/framework/vue/reference/functions/queryOptions.md
  • docs/framework/vue/reference/functions/useInfiniteQuery.md
  • docs/framework/vue/reference/functions/useIsFetching.md
  • docs/framework/vue/reference/functions/useIsMutating.md
  • docs/framework/vue/reference/functions/useMutation.md
  • docs/framework/vue/reference/functions/useMutationState.md
  • docs/framework/vue/reference/functions/usePrefetchInfiniteQuery.md
  • docs/framework/vue/reference/functions/usePrefetchQuery.md
  • docs/framework/vue/reference/functions/useQueries.md
  • docs/framework/vue/reference/functions/useQuery.md
  • docs/framework/vue/reference/functions/useQueryClient.md
  • scripts/generate-docs.ts

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


📝 Walkthrough

Walkthrough

The Vue documentation generator now defines legacy URL redirects. The affected Vue guide and function reference pages include matching redirect_from frontmatter entries.

Changes

Vue documentation redirects

Layer / File(s) Summary
Legacy path redirect coverage
scripts/generate-docs.ts, docs/framework/vue/guides/ssr.md, docs/framework/vue/reference/functions/*
The Vue documentation configuration and page frontmatter map legacy hydration, query, mutation, prefetch, and QueryClient paths to current pages.

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

Merge Risk: ⚪ Minimal · up to 75036

Legacy Vue reference URLs now redirect to their current function pages or the SSR guide, preserving existing documentation links without changing runtime behavior. The change is ready to merge.

Suggested reviewers: alemtuzlak

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly describes the main change: registering redirect mappings for Vue Query reference pages.
Description check ✅ Passed The description explains the migration context, lists the redirect changes, documents validation, and completes the required checklist and release-impact sections.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 1…
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 docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/vue-query-redirect-from

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.

@github-actions

github-actions Bot commented Sep 5, 2026

Copy link
Copy Markdown
Contributor

🚀 Changeset Version Preview

2 package(s) bumped directly, 23 bumped as dependents.

🟨 Minor bumps

Package Version Reason
@tanstack/svelte-query 6.1.48 → 6.2.0 Changeset
@tanstack/svelte-query-devtools 6.1.48 → 6.2.0 Dependent
@tanstack/svelte-query-persist-client 6.1.48 → 6.2.0 Dependent
@tanstack/vue-query-devtools 6.1.48 → 6.2.0 Dependent

🟩 Patch bumps

Package Version Reason
@tanstack/query-core 5.102.8 → 5.102.9 Changeset
@tanstack/angular-query-experimental 5.102.8 → 5.102.9 Dependent
@tanstack/angular-query-persist-client 5.102.8 → 5.102.9 Dependent
@tanstack/eslint-plugin-query 5.102.8 → 5.102.9 Dependent
@tanstack/lit-query 0.2.20 → 0.2.21 Dependent
@tanstack/preact-query 5.102.8 → 5.102.9 Dependent
@tanstack/preact-query-devtools 5.102.8 → 5.102.9 Dependent
@tanstack/preact-query-persist-client 5.102.8 → 5.102.9 Dependent
@tanstack/query-async-storage-persister 5.102.8 → 5.102.9 Dependent
@tanstack/query-broadcast-client-experimental 5.102.8 → 5.102.9 Dependent
@tanstack/query-devtools 5.102.8 → 5.102.9 Dependent
@tanstack/query-persist-client-core 5.102.8 → 5.102.9 Dependent
@tanstack/query-sync-storage-persister 5.102.8 → 5.102.9 Dependent
@tanstack/react-query 5.102.8 → 5.102.9 Dependent
@tanstack/react-query-devtools 5.102.8 → 5.102.9 Dependent
@tanstack/react-query-next-experimental 5.102.8 → 5.102.9 Dependent
@tanstack/react-query-persist-client 5.102.8 → 5.102.9 Dependent
@tanstack/solid-query 5.102.8 → 5.102.9 Dependent
@tanstack/solid-query-devtools 5.102.8 → 5.102.9 Dependent
@tanstack/solid-query-persist-client 5.102.8 → 5.102.9 Dependent
@tanstack/vue-query 5.102.8 → 5.102.9 Dependent

@pkg-pr-new

pkg-pr-new Bot commented Sep 5, 2026

Copy link
Copy Markdown
More templates

@tanstack/angular-query-experimental

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

@tanstack/eslint-plugin-query

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

@tanstack/lit-query

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

@tanstack/preact-query

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

@tanstack/preact-query-devtools

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

@tanstack/preact-query-persist-client

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

@tanstack/query-async-storage-persister

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

@tanstack/query-broadcast-client-experimental

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

@tanstack/query-core

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

@tanstack/query-devtools

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

@tanstack/query-persist-client-core

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

@tanstack/query-sync-storage-persister

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

@tanstack/react-query

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

@tanstack/react-query-devtools

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

@tanstack/react-query-next-experimental

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

@tanstack/react-query-persist-client

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

@tanstack/solid-query

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

@tanstack/solid-query-devtools

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

@tanstack/solid-query-persist-client

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

@tanstack/svelte-query

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

@tanstack/svelte-query-devtools

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

@tanstack/svelte-query-persist-client

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

@tanstack/vue-query

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

@tanstack/vue-query-devtools

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

commit: 750363b

@github-actions

github-actions Bot commented Sep 5, 2026

Copy link
Copy Markdown
Contributor

size-limit report 📦

Path Size
react full 11.87 KB (0%)
react minimal 8.84 KB (0%)

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