SolidStart: expand docs on rendering modes - #1308
Conversation
Sorry, something went wrong.
|
|
Sorry, something went wrong.
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 mode parameter 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.
Sorry, something went wrong.
✅ Deploy Preview for solid-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Sorry, something went wrong.
❌ Deploy Preview for solid-docs failed. Why did it fail? →
|
Sorry, something went wrong.
There was a problem hiding this comment.
Pull Request Overview
Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Sorry, something went wrong.
|
|
||
| - Data-fetching: client-side only, first load will render Suspense fallbacks. | ||
| - Time To First Byte (TTFB): fast since the server-side rendering is minimal. | ||
| - Total page load time: slower since the client-side rendering is heavier. |
Copilot
AI
Oct 26, 2025
There was a problem hiding this comment.
The phrase 'to render the page' is repeated. Remove the first occurrence to read: 'Uses renderToString from Solid's core to render the page synchronously.'
| - Total page load time: slower since the client-side rendering is heavier. | |
| Uses [`renderToString`](/reference/rendering/render-to-string) from Solid's core to render the page synchronously. |
Sorry, something went wrong.
…es.mdx Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…es.mdx Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
| ### Async Mode | ||
|
|
||
| Uses [`renderToStringAsync`](/reference/rendering/render-to-string-async) to render the page from Solid's core to render the page asynchronously. | ||
| Uses [`renderToStringAsync`](/reference/rendering/render-to-string-async) from Solid's core to render the page asynchronously. |
There was a problem hiding this comment.
duplicate line here
Sorry, something went wrong.
| ::: | ||
|
|
||
| Asynchronous features will happen in the Server-Side during first render. | ||
| Uses [`renderToStream`](/reference/rendering/render-to-stream) from Solid's core to render the page streaming. |
There was a problem hiding this comment.
This render to stream part should probably be below
Sorry, something went wrong.
|
|
||
| The modes can be defined app-wide via the configuration file or via the [`entry-server.tsx`](/solid-start/reference/entrypoints/entry-server) file. | ||
|
|
||
| ```tsx title="app.config.ts" |
There was a problem hiding this comment.
this changes to vite.config.ts now?
Sorry, something went wrong.
Reviewers
At least 1 approving review is required to merge this pull request.
This better clarifies how to change rendering mode per route, in the configuration, and what would be the use-cases for each mode.