docs: document custom serialization adapters in Start
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 15.1k
- Forks
- 1.9k
- Avg merge
- 1d 20h
- Merged PRs (30d)
- 143
Description
The Router SSR guide still says application-level serialization customization is being worked on. Start now supports serializationAdapters through createStart, and applies them to SSR hydration and server-function serialization.
Update the stale SSR guidance and add Start documentation that covers:
- Creating an adapter with
createSerializationAdapter - Registering adapters through
createStart({ serializationAdapters }) - A custom type example such as Prisma
Decimal - Adapter use in SSR and server-function payloads
- Built-in serialization support, including
BigInt
Related Work: #3785
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the current Router SSR guide and the existing Start documentation entry points, then locate the stale serialization guidance. Document adapter creation and registration, a custom type example, SSR and server-function payload usage, and built-in support such as BigInt; done means the outdated statement is removed and all listed topics are covered.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 72/100