docs: update Svelte recommendation#4085
Conversation
|
Caution Review failedThe pull request is closed. WalkthroughThe documentation update revises the recommended routing method for Svelte-based projects. It replaces the previous guidance to use Changes
Sequence Diagram(s)sequenceDiagram
participant U as User
participant SK as SvelteKit
participant A as Adapter-Static
U->>SK: Request page load
SK->>A: Check routing config (prerender=true, ssr=false)
A-->>SK: Serve static SPA asset
SK->>U: Return pre-rendered page
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
website/versioned_docs/version-v2.10/guides/routing.mdx (1)
54-55: Clear Code Snippet for SPA Configuration
The snippet exportingprerender = true;andssr = false;succinctly demonstrates the required configuration for a static SPA in SvelteKit. If possible, consider a brief inline comment in the snippet to explain that disabling SSR while enabling prerendering is intended for SPA scenarios.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
website/versioned_docs/version-v2.10/guides/routing.mdx(1 hunks)
🔇 Additional comments (2)
website/versioned_docs/version-v2.10/guides/routing.mdx (2)
51-52: Update to Svelte Routing Recommendation
The updated text clearly advocates for SvelteKit’s adapter‑static SPA configuration, which is a more future‑proof choice given the active development of SvelteKit. Ensure that this recommendation aligns with other parts of the docs if legacy Svelte projects exist.
58-59: Verify and Clarify Documentation Link
The line “See the guide for full details.” uses a relative link that might be clear in the context of your docs system. However, please verify that the link resolves correctly for all users. Optionally, consider providing a more descriptive link text or URL if the docs platform supports it.
|
Thanks 🙏 Please could you add an entry to the changelog located at |
|
Hi Ben, fun to see you here! 👋 |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
website/src/pages/changelog.mdx (1)
19-19: Clarify the changelog entry details.The new changelog entry clearly notes the updated Svelte router recommendation per PR #4085. To make it even more informative for users, consider adding a brief mention of the new recommendation (e.g. “using SvelteKit’s adapter‑static with SPA configuration” instead of
svelte-spa-router). This extra detail would help readers immediately understand the change without needing to refer to the PR discussion.
|
Cheers Ben! Appreciate your time doing this 🙏 Good to see you here! 👍 |
Description
Hi, I'm a Svelte maintainer and a community member just shared with me a link to the Svelte page. Our official recommendation would be to always use SvelteKit as your router in Svelte as it's backed by the core team and actively developed and most tutorials and content will reference it. I don't know much about
svelte-spa-router, but it doesn't look like it's really been updated in a year and it feels like users will be sent down a less trodden path that way.It looks like your docs are versioned and I'm just updating one version, so let me know if there's more I need to do on that front.
Type of change
Please select the option that is relevant.
How Has This Been Tested?
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration using
wails doctor.If you checked Linux, please specify the distro and version.
Test Configuration
Please paste the output of
wails doctor. If you are unable to run this command, please describe your environment in as much detail as possible.Checklist:
website/src/pages/changelog.mdxwith details of this PRSummary by CodeRabbit