Skip to content

add docs about serialization modes#1436

Merged
atilafassina merged 10 commits into
mainfrom
serialization/docs
Mar 4, 2026
Merged

add docs about serialization modes#1436
atilafassina merged 10 commits into
mainfrom
serialization/docs

Conversation

@atilafassina

Copy link
Copy Markdown
Member

this adds some docs around the new serialization modes introduced in 1.3.0 and 2.0.0-alpha.2

@atilafassina atilafassina requested a review from lxsmnsyc March 3, 2026 19:33
@atilafassina atilafassina self-assigned this Mar 3, 2026
Copilot AI review requested due to automatic review settings March 3, 2026 19:33
@bolt-new-by-stackblitz

Copy link
Copy Markdown

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

@netlify

netlify Bot commented Mar 3, 2026

Copy link
Copy Markdown

Deploy Preview for solid-docs ready!

Name Link
🔨 Latest commit 193015e
🔍 Latest deploy log https://app.netlify.com/projects/solid-docs/deploys/69a82f28279e000008a87070
😎 Deploy Preview https://deploy-preview-1436--solid-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds documentation for SolidStart’s server function serialization modes and how they interact with CSP, linking the new configuration option from relevant server-function/security docs.

Changes:

  • Add a new serialization section to defineConfig docs, describing json vs js modes and defaults.
  • Cross-link serialization configuration from the "use server" reference and the Security guide.
  • Minor formatting/whitespace adjustments in the touched MDX files.

Reviewed changes

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

File Description
src/routes/solid-start/reference/server/use-server.mdx Adds a link from server-function serialization docs to defineConfig#serialization and small formatting tweaks.
src/routes/solid-start/reference/config/define-config.mdx Documents the new serialization config option (modes/defaults) and adds it to the parameters table.
src/routes/solid-start/guides/security.mdx Adds CSP guidance referencing JSON serialization to avoid unsafe-eval, plus minor formatting fixes.

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

Comment thread src/routes/solid-start/reference/config/define-config.mdx Outdated
Comment thread src/routes/solid-start/guides/security.mdx Outdated
Comment thread src/routes/solid-start/reference/server/use-server.mdx Outdated
Comment thread src/routes/solid-start/reference/config/define-config.mdx
Comment thread src/routes/solid-start/guides/security.mdx
@lxsmnsyc

lxsmnsyc commented Mar 4, 2026

Copy link
Copy Markdown
Member

We can probably mention the data types we specifically support since seroval's compat table only shows what it can provide, but not by default.

https://github.com/solidjs/solid-start/blob/926336caaeddd8a8a72b73d3e524f8d9d3d414d2/packages/start/src/server/serialization.ts#L25-L37

atilafassina and others added 5 commits March 4, 2026 11:36
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>
Comment thread src/routes/solid-start/reference/config/define-config.mdx Outdated
@atilafassina atilafassina enabled auto-merge (squash) March 4, 2026 15:02
@atilafassina atilafassina merged commit e1dcb05 into main Mar 4, 2026
10 checks passed
@atilafassina atilafassina deleted the serialization/docs branch March 4, 2026 15:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants