Skip to content

Conversation

@m9tdev
Copy link

@m9tdev m9tdev commented Nov 13, 2025

Added an example on how to add serialization adapters for React Start. Not 100% sure if the right place is in the server function docs. LMK otherwise!

Summary by CodeRabbit

  • Documentation
    • Added a comprehensive "Custom serialization adapters" guide with a complete example (includes a bigint adapter) for handling complex types.
    • Guide published in both React and Solid server-functions guides; the React guide includes the new section in two locations for easier discovery.
    • No changes to public APIs or declarations.

✏️ Tip: You can customize this high-level summary in your review settings.

@github-actions github-actions bot added the documentation Everything documentation related label Nov 13, 2025
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 13, 2025

Walkthrough

Adds a new "Custom serialization adapters" documentation section to the Server Functions guides for React and Solid, including a TypeScript bigint adapter example; the React guide contains the same section inserted twice. No public API or exported declarations were changed.

Changes

Cohort / File(s) Summary
Server Functions documentation — React
docs/start/framework/react/guide/server-functions.md
Inserted a "Custom serialization adapters" section (TypeScript bigint adapter example) in two locations within the guide; shows how to create an adapter with createSerializationAdapter and register it via start configuration.
Server Functions documentation — Solid
docs/start/framework/solid/guide/server-functions.md
Added a "Custom serialization adapters" section with a TypeScript bigint adapter example and instructions to register the adapter via the start configuration.

Sequence Diagram(s)

(Not applicable — documentation-only changes; no control-flow or runtime behavior changes to diagram.)

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

  • Verify whether the duplicated section in docs/start/framework/react/guide/server-functions.md is intentional or should be consolidated.

Possibly related PRs

Poem

🐇 I nibble docs by lantern-light,

I teach bigints to take their flight,
Two pages hum the same small song,
A tiny adapter hopping along.

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs(react-start): serialization adapters' clearly and concisely identifies the primary change—adding documentation about serialization adapters to the React Start guide.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9503de0 and 02f1439.

📒 Files selected for processing (1)
  • docs/start/framework/solid/guide/server-functions.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/start/framework/solid/guide/server-functions.md

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@birkskyum
Copy link
Member

@m9tdev can you add the same to the solid docs so they stay in sync?

@schiller-manuel
Copy link
Contributor

we need to document serialization adapters more generally, not just for server functions. they apply for beforeLoad and loader as well. a separate doc page should be added for this. want to do this when i find the time :)

@m9tdev
Copy link
Author

m9tdev commented Nov 18, 2025

@birkskyum Should they be the same for Solid? I have no experience with Solid, but if they are the same I'll add them!

@schiller-manuel Maybe we can add this in the meantime to save others some time when looking for it.

@nx-cloud
Copy link

nx-cloud bot commented Nov 18, 2025

View your CI Pipeline Execution ↗ for commit 86875e6

Command Status Duration Result
nx affected --targets=test:eslint,test:unit,tes... ✅ Succeeded <1s View ↗
nx run-many --target=build --exclude=examples/*... ✅ Succeeded 2s View ↗

☁️ Nx Cloud last updated this comment at 2025-11-18 10:43:12 UTC

@birkskyum
Copy link
Member

birkskyum commented Nov 18, 2025

Yes it's the same for solid, except for the package name being solid-start

@m9tdev m9tdev force-pushed the docs-start-serialization-adapter branch from e1ba504 to 9503de0 Compare November 25, 2025 11:09
@m9tdev
Copy link
Author

m9tdev commented Nov 25, 2025

@birkskyum done! There was nothing in there yet (except some frontmatter), but I've added it for Solid.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e1ba504 and 9503de0.

📒 Files selected for processing (2)
  • docs/start/framework/react/guide/server-functions.md (1 hunks)
  • docs/start/framework/solid/guide/server-functions.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/start/framework/react/guide/server-functions.md
🧰 Additional context used
📓 Path-based instructions (1)
docs/**/*.md

📄 CodeRabbit inference engine (AGENTS.md)

Use relative internal documentation links relative to docs/ folder (e.g., ./guide/data-loading)

Files:

  • docs/start/framework/solid/guide/server-functions.md
🧠 Learnings (2)
📚 Learning: 2025-11-25T00:18:21.258Z
Learnt from: CR
Repo: TanStack/router PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-11-25T00:18:21.258Z
Learning: Applies to packages/solid-router/**/*.{ts,tsx} : Solid Router components and primitives should use the tanstack/solid-router package

Applied to files:

  • docs/start/framework/solid/guide/server-functions.md
📚 Learning: 2025-11-25T00:18:21.258Z
Learnt from: CR
Repo: TanStack/router PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-11-25T00:18:21.258Z
Learning: Applies to packages/react-router/**/*.{ts,tsx} : React Router components and hooks should use the tanstack/react-router package

Applied to files:

  • docs/start/framework/solid/guide/server-functions.md

@m9tdev m9tdev force-pushed the docs-start-serialization-adapter branch from 9503de0 to 02f1439 Compare November 25, 2025 11:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Everything documentation related missing-solid-version

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants