Skip to content

Conversation

@lachlancollins
Copy link
Member

@lachlancollins lachlancollins commented Nov 29, 2025

🎯 Changes

Updates casing of links in sidebar (config.json)
Also tweaks a svelte page

✅ Checklist

  • I have followed the steps in the Contributing guide.
  • I have tested this code locally with pnpm run test:pr.

🚀 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
    • Enhanced Svelte migration documentation with updated code examples and best practices for the latest API
    • Corrected and expanded framework function reference documentation for improved navigation and accuracy

✏️ Tip: You can customize this high-level summary in your review settings.

@changeset-bot
Copy link

changeset-bot bot commented Nov 29, 2025

⚠️ No Changeset found

Latest commit: 4726170

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Nov 29, 2025
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 29, 2025

Walkthrough

Documentation updates correcting function reference capitalization in navigation config and updating Svelte migration examples to reflect new API patterns including thunk-based createQuery syntax, signal-based state management, and removal of store prefix syntax.

Changes

Cohort / File(s) Summary
Navigation configuration
docs/config.json
Corrected function reference capitalization (createquery → createQuery) and added new Svelte function entries (createQueries, createInfiniteQuery, useIsFetching, useIsMutating, useMutationState, queryOptions, infiniteQueryOptions); fixed Angular injectQuery/injectMutation paths.
Svelte migration guide
docs/framework/svelte/migrate-from-v5-to-v6.md
Updated createQuery usage examples to use thunk syntax (createQuery(() => ({ ... }))), replaced store-based $ prefix syntax with direct signal access, and changed reactivity patterns from writable stores to state signals.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

  • Straightforward config updates with consistent capitalization corrections across function references
  • Documentation example corrections following established API patterns (no logic changes)

Possibly related PRs

Suggested labels

documentation

Poem

🐰 Our docs hop through the clover,
Capitalizing all the way,
Signals sing and thunks take over,
Migration guides light the way!
Time to update and celebrate! ✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title 'docs: fix sidebar links' accurately describes the main change: correcting casing in sidebar links within config.json.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description check ✅ Passed The PR description follows the required template with all sections completed: Changes, Checklist, and Release Impact. The author clearly states the purpose (updates casing of links in sidebar), marks checklist items appropriately, and correctly identifies this as a docs-only change.
✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch fix-docs

Comment @coderabbitai help to get the list of available commands and usage tips.

@nx-cloud
Copy link

nx-cloud bot commented Nov 29, 2025

View your CI Pipeline Execution ↗ for commit 4726170

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

☁️ Nx Cloud last updated this comment at 2025-11-29 20:49:07 UTC

@pkg-pr-new
Copy link

pkg-pr-new bot commented Nov 29, 2025

More templates

@tanstack/angular-query-experimental

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

@tanstack/eslint-plugin-query

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

@tanstack/query-async-storage-persister

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

@tanstack/query-broadcast-client-experimental

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

@tanstack/query-core

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

@tanstack/query-devtools

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

@tanstack/query-persist-client-core

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

@tanstack/query-sync-storage-persister

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

@tanstack/react-query

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

@tanstack/react-query-devtools

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

@tanstack/react-query-next-experimental

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

@tanstack/react-query-persist-client

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

@tanstack/solid-query

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

@tanstack/solid-query-devtools

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

@tanstack/solid-query-persist-client

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

@tanstack/svelte-query

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

@tanstack/svelte-query-devtools

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

@tanstack/svelte-query-persist-client

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

@tanstack/vue-query

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

@tanstack/vue-query-devtools

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

commit: 4726170

@github-actions
Copy link
Contributor

Sizes for commit 4726170:

Branch Bundle Size
Main
This PR

@lachlancollins lachlancollins merged commit 7e99b88 into main Nov 29, 2025
7 checks passed
@lachlancollins lachlancollins deleted the fix-docs branch November 29, 2025 21:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants