SolidStart: expand docs on rendering modes #1308
Conversation
|
|
There was a problem hiding this comment.
Pull Request Overview
This PR enhances the SolidStart documentation by expanding the explanation of rendering modes (sync, async, and stream). It clarifies how to configure rendering modes globally and per-route, and provides guidance on when to use each mode.
- Adds a comprehensive new page explaining rendering modes with use cases and feature comparisons
- Updates configuration and server entry point references to link to the new rendering modes documentation
- Adds
modeparameter documentation to the config reference
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| src/routes/solid-start/building-your-application/rendering-modes.mdx | New comprehensive guide explaining the three rendering modes, their features, and configuration options |
| src/routes/solid-start/building-your-application/data.json | Adds the new rendering modes page to the navigation |
| src/routes/solid-start/reference/server/create-handler.mdx | Updated to reference the new rendering modes page and improved type signature documentation |
| src/routes/solid-start/reference/entrypoints/entry-server.mdx | Simplified with references to the new rendering modes documentation |
| src/routes/solid-start/reference/config/define-config.mdx | Added mode parameter documentation and formatting improvements |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
src/routes/solid-start/building-your-application/rendering-modes.mdx
Outdated
Show resolved
Hide resolved
src/routes/solid-start/building-your-application/rendering-modes.mdx
Outdated
Show resolved
Hide resolved
src/routes/solid-start/building-your-application/rendering-modes.mdx
Outdated
Show resolved
Hide resolved
src/routes/solid-start/building-your-application/rendering-modes.mdx
Outdated
Show resolved
Hide resolved
src/routes/solid-start/building-your-application/rendering-modes.mdx
Outdated
Show resolved
Hide resolved
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
✅ Deploy Preview for solid-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for solid-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
| Let's talk about how each of them work and which one to pick. | ||
|
|
||
| :::note | ||
| Default is **stream** and performance-wise should be preferred as a rule-of-thumb. |
There was a problem hiding this comment.
Why should this be preferred?
| --- | ||
|
|
||
| SolidStart has 3 kinds of rendering modes: `sync`, `async`, and `stream`. | ||
| Let's talk about how each of them work and which one to pick. |
There was a problem hiding this comment.
This line makes sense in a blogpost or guide. Maybe for this scenario you can just remove it?
| All modes have some degree of Server-Side Rendering, you may need to change them globally depending on your deployment provider. | ||
| And you may prefer to override them for better bot support and SEO. | ||
|
|
||
| ## Impacted Features |
There was a problem hiding this comment.
Could you provide some extra context that makes the next table understandable. Currently I was trying to figure out what each item means and how it impacts those features
2 participants
This better clarifies how to change rendering mode per route, in the configuration, and what would be the use-cases for each mode.