docs: redirect flat reference URLs broken by the TypeDoc migration - #11379
Merged
Conversation
|
View your CI Pipeline Execution ↗ for commit a3fe250
☁️ Nx Cloud last updated this comment at |
Contributor
🚀 Changeset Version Preview2 package(s) bumped directly, 23 bumped as dependents. 🟨 Minor bumps
🟩 Patch bumps
|
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Team Run ID: 📒 Files selected for processing (40)
Included review availability: Your plan provides up to 10 included reviews per hour; 9 remain after this review. 📝 WalkthroughWalkthroughThe documentation generator now applies configured ChangesDocumentation redirect metadata
Estimated code review effort: 2 (Simple) | ~10 minutes Merge Risk: ⚪ Minimal · up to This change adds static legacy documentation redirects and preserves them through regeneration. No current merge-readiness risk remains. Suggested reviewers: 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
Full details: Docstring CoverageExplanation Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 4 functions across 1 files. (39 skipped: 39 unsupported.)
✨ Finishing Touches 💡 1📝 Generate docstrings 💡
🧪 Generate unit tests (beta)
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. Comment |
Contributor
size-limit report 📦
|
TkDodo
approved these changes
Sep 3, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
🎯 Changes
Fixes broken links for
docs/framework/{react,solid}/reference/*.mdURLs that returned a flat page before the TypeDoc migration (react: #11205/#11366, solid: #11368/#11369) moved them underfunctions/. Requests to the old flat URLs currently fall through to the framework docs index instead of resolving. Reported in #11371.Adds
redirect_fromfrontmatter (per tanstack.com's redirect convention) to the affected pages, split into two kinds:functions/*.md, 19 react + 10 solid):scripts/generate-docs.tsnow injectsredirect_frominto each package's TypeDoc output as a post-processing step, keyed off a per-package mapping. This runs on everypnpm run generate-docs, so the redirects survive regeneration without manual upkeep.docs/reference/*.md(9 files —QueryClient,QueryCache,MutationCache,QueryObserver,QueriesObserver,InfiniteQueryObserver,focusManager,notifyManager,onlineManager) anddocs/framework/react/guides/ssr.md. These pages aren't generated by the script (query-core is excluded from every framework's TypeDoc entry point, andhydration.md's content lives in the SSR guide), so theirredirect_fromwas added directly and isn't part of the generation pipeline.docs/framework/solid/reference/hydration.mdis not redirected — its content was never anything but a react-guide clone (ref:/replace:) anddocs/framework/solid/guides/ssr.mdis currently a stub, so there's no real target to send readers to.✅ Checklist
pnpm run test:pr, or these tests do not apply to this pull request.🚀 Release Impact
Summary by CodeRabbit