SolidStart: expand docs on rendering modes #1308

atilafassina · 2025-10-20T16:35:30Z

This better clarifies how to change rendering mode per route, in the configuration, and what would be the use-cases for each mode.

bolt-new-by-stackblitz · 2025-10-20T16:35:33Z

Run & review this pull request in StackBlitz Codeflow.

Copilot

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.}

src/routes/solid-start/building-your-application/rendering-modes.mdx

Co-authored-by: Copilot <[email protected]>

netlify · 2025-10-20T16:43:47Z

✅ Deploy Preview for solid-docs ready!

Name	Link
🔨 Latest commit	`c83f957`
🔍 Latest deploy log	https://app.netlify.com/projects/solid-docs/deploys/68f664d54d382500088bdeea
😎 Deploy Preview	https://deploy-preview-1308--solid-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

netlify · 2025-10-20T16:44:52Z

✅ Deploy Preview for solid-docs ready!

Name	Link
🔨 Latest commit	`ea97511`
🔍 Latest deploy log	https://app.netlify.com/projects/solid-docs/deploys/68fe6bdcae72230008b836aa
😎 Deploy Preview	https://deploy-preview-1308--solid-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

src/routes/solid-start/building-your-application/rendering-modes.mdx

Copilot

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.

Copilot · 2025-10-26T18:42:13Z

src/routes/solid-start/building-your-application/rendering-modes.mdx

+
+- 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.


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.'

Suggested change

- 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.

src/routes/solid-start/building-your-application/rendering-modes.mdx

…es.mdx Co-authored-by: Copilot <[email protected]>

Copilot

Pull Request Overview

Copilot reviewed 5 out of 5 changed files in this pull request and generated 4 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-10-26T18:44:43Z

src/routes/solid-start/building-your-application/rendering-modes.mdx

+### 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.


Duplicate line: Line 31 repeats the same content as line 30. Remove the duplicate line.

Suggested change

Uses [`renderToStringAsync`](/reference/rendering/render-to-string-async) from Solid's core to render the page asynchronously.

Copilot · 2025-10-26T18:44:43Z

src/routes/solid-start/building-your-application/rendering-modes.mdx

+Uses [`renderToStream`](/reference/rendering/render-to-stream) from Solid's core to render the page streaming.
+- **Data-fetching**: first render will be similar to sync mode, but data fetching will still happen in the background and responses will be streamed in chunks as available.


The description at line 38 appears to be misplaced in the Async Mode section. This line describes stream mode functionality but is located within the Async Mode section (after line 37 which discusses server-side features for async mode). It should either be removed from this section or the section structure needs to be corrected.

Copilot · 2025-10-26T18:44:43Z

src/routes/solid-start/building-your-application/rendering-modes.mdx

+	mode: (event) => {
+		return { mode: event.request.url.includes("/special-route") ? "async" : "stream" };
+	}


The options parameter should be a function that returns an object with a mode property, but the signature shows it can also be just an object. The example wraps the mode in a function that returns an object, but based on the type signature in create-handler.mdx (line 35), when using a function, it should return { mode: RenderingModes } directly. The current example has an unnecessary wrapper function—it should be (event) => ({ mode: event.request.url.includes(\"/special-route\") ? \"async\" : \"stream\" }).

Suggested change

mode: (event) => {

return { mode: event.request.url.includes("/special-route") ? "async" : "stream" };

}

mode: (event) => ({ mode: event.request.url.includes("/special-route") ? "async" : "stream" })

Copilot · 2025-10-26T18:44:44Z

src/routes/solid-start/building-your-application/rendering-modes.mdx

+	mode: (event) => {
+		return { mode: isBot(event.request.userAgent) ? "async" : "stream" };
+	}


Same issue as Comment 3: The function should directly return the object ({ mode: isBot(event.request.userAgent) ? \"async\" : \"stream\" }) without the explicit return statement and extra braces, to match the type signature.

Suggested change

mode: (event) => {

return { mode: isBot(event.request.userAgent) ? "async" : "stream" };

}

mode: (event) => ({ mode: isBot(event.request.userAgent) ? "async" : "stream" })

expand docs on rendering modes

c83f957

atilafassina requested a review from Copilot October 20, 2025 16:35

atilafassina self-assigned this Oct 20, 2025

Copilot AI reviewed Oct 20, 2025

View reviewed changes

atilafassina and others added 5 commits October 20, 2025 18:37

typo-1

28afce1

Co-authored-by: Copilot <[email protected]>

typo-2

2e8d401

Co-authored-by: Copilot <[email protected]>

typo-3

7a73d35

Co-authored-by: Copilot <[email protected]>

typo-4

926ff16

Co-authored-by: Copilot <[email protected]>

typooo

08b8670

Co-authored-by: Copilot <[email protected]>

atilafassina marked this pull request as ready for review October 20, 2025 16:38

kodiakhq bot added 3 commits October 20, 2025 22:51

Merge branch 'main' into docs/rendering-modes

41d8ff0

Merge branch 'main' into docs/rendering-modes

3207564

Merge branch 'main' into docs/rendering-modes

4bdba75

atilafassina enabled auto-merge (squash) October 21, 2025 07:28

Merge branch 'main' into docs/rendering-modes

a02ed4c

atilafassina added the solidstart Related to SolidStart label Oct 21, 2025

atilafassina requested a review from danieljcafonso October 21, 2025 12:17

danieljcafonso reviewed Oct 21, 2025

View reviewed changes

kodiakhq bot added 2 commits October 21, 2025 12:58

Merge branch 'main' into docs/rendering-modes

4d313c3

Merge branch 'main' into docs/rendering-modes

b7fb815

atilafassina requested review from Copilot and danieljcafonso October 26, 2025 18:41

big rewording

717bca0

Copilot AI reviewed Oct 26, 2025

View reviewed changes

atilafassina and others added 2 commits October 26, 2025 19:43

Update src/routes/solid-start/building-your-application/rendering-mod…

c56434a

…es.mdx Co-authored-by: Copilot <[email protected]>

Update src/routes/solid-start/building-your-application/rendering-mod…

ea97511

…es.mdx Co-authored-by: Copilot <[email protected]>

atilafassina requested a review from Copilot October 26, 2025 18:43

Copilot AI reviewed Oct 26, 2025

View reviewed changes

	- 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.

		Uses [`renderToStream`](/reference/rendering/render-to-stream) from Solid's core to render the page streaming.
		- Data-fetching: first render will be similar to sync mode, but data fetching will still happen in the background and responses will be streamed in chunks as available.

SolidStart: expand docs on rendering modes #1308

Are you sure you want to change the base?

SolidStart: expand docs on rendering modes #1308

Conversation

atilafassina commented Oct 20, 2025

Uh oh!

bolt-new-by-stackblitz bot commented Oct 20, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

netlify bot commented Oct 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for solid-docs ready!

Uh oh!

netlify bot commented Oct 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for solid-docs ready!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Copilot AI Oct 26, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Copilot AI Oct 26, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 26, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 26, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 26, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

netlify bot commented Oct 20, 2025 •

edited

Loading

netlify bot commented Oct 20, 2025 •

edited

Loading