-
Notifications
You must be signed in to change notification settings - Fork 329
SolidStart: expand docs on rendering modes #1308
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
Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.
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.
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 <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
✅ 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. |
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.
Why should this be preferred?
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.
This line makes sense in a blogpost or guide. Maybe for this scenario you can just remove it?
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.
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
This better clarifies how to change rendering mode per route, in the configuration, and what would be the use-cases for each mode.