-
-
Notifications
You must be signed in to change notification settings - Fork 38
doc: updates to sveltekit adapter and svelte-query integration docs #543
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.
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
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
WalkthroughUpdates documentation for SvelteKit server adapter and TanStack Query client SDK. The SvelteKit guide restructures API mounting approaches, introduces API Routes as the recommended method with deprecation notice for Server Hooks, and updates import patterns. The TanStack Query docs adds a preview feature banner for Svelte support. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~15 minutes Possibly related PRs
Pre-merge checks✅ Passed checks (3 passed)
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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (1)
docs/reference/server-adapters/sveltekit.mdx (1)
55-59: Clear deprecation notice.The deprecation warning effectively communicates that Server Hooks are deprecated and directs users to use API Routes instead.
Optional: Consider adding timeline information
If there's a specific version or timeframe for removal, consider adding it to help users plan their migration:
:::warning -The server hooks method is deprecated and will be removed in a future release. Use API routes instead. +The server hooks method is deprecated and will be removed in version X.X. Use API routes instead. :::
📜 Review details
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/reference/server-adapters/sveltekit.mdxdocs/service/client-sdk/tanstack-query/index.md
🔇 Additional comments (7)
docs/service/client-sdk/tanstack-query/index.md (2)
54-55: LGTM!The PreviewFeature banner is appropriately placed to highlight that Svelte support is in preview. The placement right after the version requirements makes it clear to users that this is a newer feature.
13-13: The import path is valid and the PreviewFeature component file exists at the expected location.docs/reference/server-adapters/sveltekit.mdx (5)
22-22: LGTM!The updated description clearly communicates both mounting approaches and immediately signals that Server Hooks are deprecated, setting the right expectations for users.
24-50: LGTM!The API Routes example is comprehensive and follows SvelteKit conventions correctly. The explicit note about the wildcard route parameter needing to be named
path(line 49) is particularly helpful, as this is a requirement that users might otherwise miss.
67-67: LGTM!The variable naming change from
clienttodbimproves semantic clarity, making it more obvious that this is a database client (likely Prisma) being authenticated.Also applies to: 75-75
83-83: LGTM!The simplified phrasing "The hooks handler takes..." is more concise while context is already established by the "Server Hooks" section heading.
51-53: LGTM!The options documentation properly references the shared AdapterOptions component and provides a clear type signature for the
getClientparameter specific to SvelteKit's RequestEvent.
Summary by CodeRabbit
Documentation
✏️ Tip: You can customize this high-level summary in your review settings.