Thanks to visit codestin.com
Credit goes to github.com

Skip to content

docs(svelte-query): fix diff notation #9717

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Sep 30, 2025
Merged

docs(svelte-query): fix diff notation #9717

merged 1 commit into from
Sep 30, 2025

Conversation

lachlancollins
Copy link
Member

@lachlancollins lachlancollins commented Sep 30, 2025 •
edited by coderabbitai bot
Loading

🎯 Changes

I didn't realise that we needed special notation for diffs on the website :)

✅ Checklist

  • I have followed the steps in the Contributing guide.
  • I have tested this code locally with pnpm 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
    • Updated Svelte migration guide (v5 → v6).
    • Renamed “Thunks” to “Function Inputs.”
    • Clarified cross-adapter guidance (Svelte, Angular, Solid) that options must be provided via a function; mentions TypeScript warnings if omitted.
    • Revised examples to use createQuery with function inputs and removed store-based prefixes in property access.
    • Updated reactivity examples to function-based patterns; retained change markers in code snippets.

@changeset-bot changeset-bot
Copy link

changeset-bot bot commented Sep 30, 2025

⚠️ No Changeset found

Latest commit: 777bcb2

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

@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Sep 30, 2025 •
edited
Loading

Caution

Review failed

The pull request is closed.

Walkthrough

Updates Svelte migration doc to adopt thunk-based function inputs across examples, adjust cross-adapter wording (Svelte, Angular, Solid), and replace store/derived patterns with thunk-based reactivity and property access. Code samples now use createQuery(() => ({ ... })) and annotate diffs with [!code --]/[!code ++].

Changes

Cohort / File(s) Summary of changes
Docs: Svelte v5→v6 migration
docs/framework/svelte/migrate-from-v5-to-v6.md		 Renames “Thunks” to “Function Inputs”; clarifies cross-adapter requirements (Svelte/Angular/Solid) for thunked options with TypeScript warnings; updates all examples to createQuery(() => ({ ... })); revises “Accessing Properties” away from stores; replaces store/derived reactivity with thunk-based patterns; maintains [!code --]/[!code ++] annotations.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

I twitch my whiskers, docs anew,
From stores to thunks, the syntax grew.
Query hops with function flair,
Reactive fields now light as air.
Across the fields—Svelte, Solid, Ng—
I thump approval: (() => { weee! })
Carrots merged; ship it, whee! 🥕🐇

✨ Finishing touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch update-svelte-docs
📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a99f771 and 777bcb2.

📒 Files selected for processing (1)
  • docs/framework/svelte/migrate-from-v5-to-v6.md (1 hunks)

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

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Sep 30, 2025
@lachlancollins lachlancollins merged commit 9f82d8e into main Sep 30, 2025
5 of 6 checks passed
@nx-cloud Nx Cloud
Copy link

nx-cloud bot commented Sep 30, 2025 •
edited
Loading

View your CI Pipeline Execution ↗ for commit 777bcb2

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

☁️ Nx Cloud last updated this comment at 2025-09-30 12:39:11 UTC

@lachlancollins lachlancollins deleted the update-svelte-docs branch September 30, 2025 12:37
@github-actions GitHub Actions
Copy link
Contributor

Sizes for commit 777bcb2:

Branch Bundle Size
Main
This PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@lachlancollins