Skip to content

Conversation

nlynzaad
Copy link
Contributor

@nlynzaad nlynzaad commented Oct 9, 2025

There are a few typos in the SSR documentation that is being addressed.

Summary by CodeRabbit

  • Documentation
    • Updated SSR guide to reflect the renamed server render handler API and aligned code samples accordingly.
    • Improved wording in Streaming SSR sections for clarity (e.g., “lower priority” phrasing).
    • Ensured examples and guidance match current public API behavior for server-side rendering.

@nlynzaad nlynzaad changed the title (Docs: SSR) Resolve typos (Docs: SSR): Resolve typos Oct 9, 2025
@github-actions github-actions bot added the documentation Everything documentation related label Oct 9, 2025
Copy link
Contributor

coderabbitai bot commented Oct 9, 2025

Walkthrough

Documentation for React Router SSR updated to replace defaultRenderToString with defaultRenderHandler in imports and examples, along with minor wording adjustments (“less priority” → “lower priority”). No functional logic changes beyond reflecting the new public API name in server-side usage examples.

Changes

Cohort / File(s) Summary of Changes
Docs: SSR API rename
docs/router/framework/react/guide/ssr.md
Updated server SSR examples to use defaultRenderHandler instead of defaultRenderToString (imports and calls). Adjusted wording in Streaming SSR sections (“lower priority”). Reflected public API rename in module @tanstack/react-router/ssr/server.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  actor User
  participant Server
  participant SSR Module as @tanstack/react-router/ssr/server
  participant Router

  User->>Server: HTTP request
  Server->>SSR Module: defaultRenderHandler(request, router)
  SSR Module->>Router: Resolve route, load data
  Router-->>SSR Module: Rendered stream/markup
  SSR Module-->>Server: Response payload
  Server-->>User: HTML/streamed response
  note over SSR Module,Server: defaultRenderHandler replaces defaultRenderToString
Loading

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

I twitched my nose at dawn’s new brand,
defaultRenderHandler hops through the land—
Strings are old burrows, handlers the trail,
Streaming winds whisper a lighter tale.
With lower-priority breezes we glide,
Docs updated—carrots stacked with pride. 🥕🐇

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Title Check ⚠️ Warning The title indicates only typo fixes in the SSR documentation, but the primary change is an update to the public API name from defaultRenderToString to defaultRenderHandler in code samples; this makes the title both misleading and insufficiently descriptive of the main changes. Please revise the title to clearly summarize the core change, for example “Docs(Router-SSR): Rename defaultRenderToString to defaultRenderHandler in SSR docs.”
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs-ssr-defaultRequestHandler

📜 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 3097080 and aad4e61.

📒 Files selected for processing (1)
  • docs/router/framework/react/guide/ssr.md (3 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
docs/**/*.{md,mdx}

📄 CodeRabbit inference engine (AGENTS.md)

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

Files:

  • docs/router/framework/react/guide/ssr.md
docs/{router,start}/**

📄 CodeRabbit inference engine (AGENTS.md)

Place router docs under docs/router/ and start framework docs under docs/start/

Files:

  • docs/router/framework/react/guide/ssr.md

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

Copy link

nx-cloud bot commented Oct 9, 2025

View your CI Pipeline Execution ↗ for commit aad4e61

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-10-09 21:02:51 UTC

@nlynzaad nlynzaad changed the title (Docs: SSR): Resolve typos Docs(SSR): Resolve typos Oct 9, 2025
@nlynzaad nlynzaad changed the title Docs(SSR): Resolve typos Docs(Router-SSR): Resolve typos Oct 9, 2025
Copy link

pkg-pr-new bot commented Oct 9, 2025

More templates

@tanstack/arktype-adapter

npm i https://pkg.pr.new/TanStack/router/@tanstack/arktype-adapter@5425

@tanstack/directive-functions-plugin

npm i https://pkg.pr.new/TanStack/router/@tanstack/directive-functions-plugin@5425

@tanstack/eslint-plugin-router

npm i https://pkg.pr.new/TanStack/router/@tanstack/eslint-plugin-router@5425

@tanstack/history

npm i https://pkg.pr.new/TanStack/router/@tanstack/history@5425

@tanstack/nitro-v2-vite-plugin

npm i https://pkg.pr.new/TanStack/router/@tanstack/nitro-v2-vite-plugin@5425

@tanstack/react-router

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-router@5425

@tanstack/react-router-devtools

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-router-devtools@5425

@tanstack/react-router-ssr-query

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-router-ssr-query@5425

@tanstack/react-start

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-start@5425

@tanstack/react-start-client

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-start-client@5425

@tanstack/react-start-server

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-start-server@5425

@tanstack/router-cli

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-cli@5425

@tanstack/router-core

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-core@5425

@tanstack/router-devtools

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-devtools@5425

@tanstack/router-devtools-core

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-devtools-core@5425

@tanstack/router-generator

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-generator@5425

@tanstack/router-plugin

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-plugin@5425

@tanstack/router-ssr-query-core

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-ssr-query-core@5425

@tanstack/router-utils

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-utils@5425

@tanstack/router-vite-plugin

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-vite-plugin@5425

@tanstack/server-functions-plugin

npm i https://pkg.pr.new/TanStack/router/@tanstack/server-functions-plugin@5425

@tanstack/solid-router

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-router@5425

@tanstack/solid-router-devtools

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-router-devtools@5425

@tanstack/solid-start

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-start@5425

@tanstack/solid-start-client

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-start-client@5425

@tanstack/solid-start-server

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-start-server@5425

@tanstack/start-client-core

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-client-core@5425

@tanstack/start-plugin-core

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-plugin-core@5425

@tanstack/start-server-core

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-server-core@5425

@tanstack/start-static-server-functions

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-static-server-functions@5425

@tanstack/start-storage-context

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-storage-context@5425

@tanstack/valibot-adapter

npm i https://pkg.pr.new/TanStack/router/@tanstack/valibot-adapter@5425

@tanstack/virtual-file-routes

npm i https://pkg.pr.new/TanStack/router/@tanstack/virtual-file-routes@5425

@tanstack/zod-adapter

npm i https://pkg.pr.new/TanStack/router/@tanstack/zod-adapter@5425

commit: aad4e61

@nlynzaad nlynzaad merged commit 4f288bf into main Oct 9, 2025
6 checks passed
@nlynzaad nlynzaad deleted the docs-ssr-defaultRequestHandler branch October 9, 2025 21:05
LadyBluenotes pushed a commit to LadyBluenotes/router that referenced this pull request Oct 10, 2025
LadyBluenotes pushed a commit to LadyBluenotes/router that referenced this pull request Oct 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Everything documentation related

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant