Repository navigation
docs(examples): add router and framework suffix to 'docs/config.json' labels and 'package.json' names - #12458
Conversation
… labels and 'package.json' names
|
|
View your CI Pipeline Execution ↗ for commit aa68bd1
☁️ Nx Cloud last updated this comment at |
🚀 Changeset Version Preview10 package(s) bumped directly, 14 bumped as dependents. 🟩 Patch bumps
|
|
No actionable comments were generated in the recent review.
 |
| Layer / File(s) | Summary |
|---|---|
Framework labels and package names docs/config.json, examples/{angular,lit,preact,react,solid,svelte,vue}/*/package.json |
Navigation labels and package names now specify framework or router variants, including Next.js routers, SolidStart versions, Nuxt 4, SvelteKit, and framework-specific routers. |
Priority:
Estimated code review effort: 2 (Simple) | ~10 minutes
Change: Other
Suggested reviewers: tkdodo
Merge Risk: 
aa68b
-
The PR changes only private example names and navigation labels, with no established runtime or release-impact risk.
Pre-merge checks: 
-
Check name Status Explanation Title check The title clearly summarizes the main changes to documentation labels and example package names. Description check The description includes the required Changes, Checklist, and Release Impact sections. It explains the naming rules, records the checklist completion, and identifies the change as docs/dev-only. Docstring Coverage No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat… Linked Issues check Check skipped because no linked issues were found for this pull request. Out of Scope Changes check Check skipped because no linked issues were found for this pull request. Full details: Docstring Coverage
-
Explanation
No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 0 files. (51 skipped: 51 unsupported.)
-
Finishing Touches
-
🧪 Generate unit tests (beta)
-
- Commit to this branch
- Create a new PR
-
- Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
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 @coderabbitai help to get the list of available commands.
…art major versions in example labels and names
size-limit report 📦
|
🎯 Changes
Makes example names show which router or meta-framework each example uses.
docs/config.json: appends the router or framework to example labels, e.g.Auto Refetching / Polling / Realtime (Next.js Pages Router),Optimistic Updates (Next.js App Router),Star Wars (React Router),Prefetching (Nuxt 4),Pagination (SolidStart 2),Basic (SvelteKit),Rick And Morty (preact-iso),Offline Queries and Mutations (@lit-labs/router),Query options from a service (Angular Router).package.json: renames examples to@tanstack/query-example-<adapter>-<directory>[-<router or framework>], e.g.@tanstack/query-example-react-auto-refetching-nextjs-pages-router,@tanstack/query-example-react-star-wars-react-router,@tanstack/query-example-vue-prefetching-nuxt4.vue-router, SolidStart with@solidjs/router), only the meta-framework is used.Solid Startis relabeled toSolidStart 1.react-router,solid-router,vue-router,nextjs-app-prefetching,simple-nuxt3) are not suffixed again. Their package names are aligned with the directory, e.g.@tanstack/query-example-react-router→@tanstack/query-example-react-react-router.✅ Checklist
pnpm run test:pr, or these tests do not apply to this pull request.🚀 Release Impact
Summary by CodeRabbit