update solid docs

[brenelz]

Summary by CodeRabbit

• Documentation
  • Updated Solid.js build and client entry point guides with improved hydration configuration and initialization flow.
  • Enhanced documentation for proper HTML document structure setup and client-side hydration lifecycle.

[coderabbitai]

Walkthrough

Updates Solid Start framework documentation to reflect revised hydration patterns, including proper HTML document structure with HydrationScript placement and introduction of the hydrateStart client initialization function.

Changes

Cohort / File(s)	Summary
Solid Start Hydration Documentation Updates docs/start/framework/solid/build-from-scratch.md	Changes Solid import from type-only to runtime namespace import, adds HydrationScript from 'solid-js/web', restructures RootDocument render from fragment to full HTML document with head and body, wraps route content in Solid.Suspense
Solid Start Client Entry Point docs/start/framework/solid/guide/client-entry-point.md	Adds hydrateStart import from '@tanstack/solid-start/client', updates client hydration flow to await hydrateStart before rendering StartClient, changes mount target from document.body to document

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

• update solid start docs #5347: Modifies the same Solid docs files with overlapping code-level changes to hydration and import examples
• fix: solid start error outside monorepo #5566: Directly overlaps with client-entry changes—consolidates StartClient and hydrateStart imports from '@tanstack/solid-start/client'
• docs: update build-from-scratch replacements for SolidJS #5216: Updates the same build-from-scratch.md file with Solid-specific imports and HTML scaffolding modifications

Suggested reviewers

• schiller-manuel
• birkskyum

Poem

🐰 With HydrationScript held tight in the head,
And hydrateStart awaited with care,
The Solid docs bloom with hydration spread—
Full HTML documents, root everywhere! ✨

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	You can run @coderabbitai generate docstrings to improve docstring coverage.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The title "update solid docs" is directly related to the changeset, which consists of updates to two Solid documentation files with changes to imports, hydration patterns, and document structure. The title accurately identifies that documentation is being updated and refers to a real part of the change. However, the title is overly broad and generic—it does not convey the specific nature of the updates, such as the hydration-related improvements or the significant structural changes to the code examples, which means a teammate scanning the history would not immediately understand what aspects of the documentation were changed or why.

✨ 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 1c5f579 and d4a26ee.

📒 Files selected for processing (2)

• docs/start/framework/solid/build-from-scratch.md (2 hunks)
• docs/start/framework/solid/guide/client-entry-point.md (1 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/start/framework/solid/guide/client-entry-point.md
• docs/start/framework/solid/build-from-scratch.md

docs/{router,start}/**

📄 CodeRabbit inference engine (AGENTS.md)

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

Files:

• docs/start/framework/solid/guide/client-entry-point.md
• docs/start/framework/solid/build-from-scratch.md

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: Preview

🔇 Additional comments (2)

docs/start/framework/solid/build-from-scratch.md (1)

157-157: Excellent structural and hydration updates that properly support the new client initialization flow.

The changes correctly reflect the revised hydration architecture:

1. Runtime Solid import (line 157): Properly changed to enable Solid.Suspense usage for async route resolution.
2. HydrationScript placement (line 164, 196): Correctly positioned in the document <head> to enable Solid's hydration mechanism.
3. Full HTML document structure (lines 194–204): Properly renders complete HTML with head, body, and correct content ordering, enabling the hydrateStart() pattern from the client entry point to hydrate into the document root.
4. Content wrapping (line 200): Solid.Suspense appropriately wraps route content to handle async loader resolution.
5. Scripts placement (line 201): Correctly positioned in the body after content for client-side initialization.

This aligns seamlessly with the updated client entry point pattern and supports the server-to-client hydration flow documented in docs/start/framework/solid/guide/client-entry-point.md.

Also applies to: 164-164, 194-204

docs/start/framework/solid/guide/client-entry-point.md (1)

29-43: Update Error Handling and Development vs Production examples to use the hydrateStart() pattern for consistency with the main example.

The main client entry point example demonstrates using hydrateStart() to obtain the router and pass it to StartClient, but the Error Handling (lines 29–43) and Development vs Production (lines 49–62) examples use the simpler hydrate() pattern targeting document.body without importing or using hydrateStart().

While both patterns are valid in Solid Start, updating the secondary examples to match the main pattern would provide consistent documentation guidance and ensure users see the recommended approach across all examples.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[nx-cloud]

View your CI Pipeline Execution ↗ for commit d4a26ee

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

---

☁️ Nx Cloud last updated this comment at 2025-10-24 14:30:29 UTC

[pkg-pr-new]

More templates

• tanstack-router-solid-example-basic
• tanstack-router-solid-example-basic-devtools-panel
• tanstack-router-solid-example-basic-file-based
• tanstack-router-solid-example-basic-non-nested-devtools
• tanstack-router-solid-example-basic-solid-query
• tanstack-router-solid-example-basic-solid-query-file-based
• tanstack-router-solid-example-basic-ssr-streaming-file-based
• tanstack-router-solid-example-kitchen-sink-file-based
• tanstack-router-solid-example-kitchen-sink-solid-query
• tanstack-router-solid-example-kitchen-sink-solid-query-file-based
• tanstack-router-solid-example-quickstart-file-based
• tanstack-solid-start-example-bare
• tanstack-solid-start-example-basic
• tanstack-solid-start-example-basic-auth
• tanstack-solid-start-example-basic-cloudflare
• tanstack-solid-start-example-basic-netlify
• tanstack-solid-start-example-basic-nitro
• tanstack-start-example-basic-solid-query
• tanstack-solid-start-example-basic-static
• tanstack-router-react-example-authenticated-routes
• tanstack-router-react-example-authenticated-routes-firebase
• tanstack-router-react-example-basic
• tanstack-router-react-example-basic-default-search-params
• tanstack-router-react-example-basic-devtools-panel
• tanstack-router-react-example-basic-file-based
• tanstack-router-react-example-basic-non-nested-devtools
• tanstack-router-react-example-react-query
• tanstack-router-react-example-basic-react-query-file-based
• tanstack-router-react-example-basic-ssr-file-based
• tanstack-router-react-example-basic-ssr-streaming-file-based
• tanstack-router-react-example-basic-virtual-file-based
• tanstack-router-react-example-basic-virtual-inside-file-based
• tanstack-router-react-example-deferred-data
• tanstack-router-i18n-paraglide
• tanstack-router-react-example-kitchen-sink
• tanstack-router-react-example-kitchen-sink-file-based
• tanstack-router-react-example-kitchen-sink-react-query
• tanstack-router-react-example-kitchen-sink-react-query-file-based
• tanstack-router-react-example-large-file-based
• tanstack-router-react-example-location-masking
• tanstack-router-react-example-navigation-blocking
• tanstack-router-react-example-quickstart
• tanstack-router-react-example-quickstart-esbuild-file-based
• tanstack-router-react-example-quickstart-file-based
• tanstack-router-react-example-quickstart-rspack-file-based
• tanstack-router-react-example-quickstart-webpack-file-based
• router-monorepo-react-query
• router-mono-simple
• router-mono-simple-lazy
• tanstack-router-react-example-scroll-restoration
• tanstack-search-validator-adapters
• tanstack-start-example-bare
• tanstack-start-example-basic
• tanstack-start-example-basic-auth
• tanstack-start-example-basic-cloudflare
• tanstack-start-example-basic-react-query
• tanstack-start-example-basic-static
• tanstack-start-bun-hosting
• tanstack-start-example-clerk-basic
• tanstack-start-example-convex-trellaux
• tanstack-start-example-counter
• tanstack-start-i18n-paraglide
• tanstack-start-example-large
• tanstack-start-example-material-ui
• tanstack-start-streaming-data-from-server-functions
• tanstack-start-example-supabase-basic
• tanstack-start-tailwind-v4
• tanstack-start-example-trellaux
• tanstack-start-example-workos
• tanstack-router-react-example-view-transitions
• tanstack-router-react-example-with-framer-motion
• tanstack-router-react-example-with-trpc
• tanstack-router-react-example-with-trpc-react-query

@tanstack/arktype-adapter

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

@tanstack/directive-functions-plugin

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

@tanstack/eslint-plugin-router

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

@tanstack/history

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

@tanstack/nitro-v2-vite-plugin

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

@tanstack/react-router

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

@tanstack/react-router-devtools

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

@tanstack/react-router-ssr-query

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

@tanstack/react-start

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

@tanstack/react-start-client

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

@tanstack/react-start-server

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

@tanstack/router-cli

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

@tanstack/router-core

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

@tanstack/router-devtools

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

@tanstack/router-devtools-core

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

@tanstack/router-generator

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

@tanstack/router-plugin

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

@tanstack/router-ssr-query-core

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

@tanstack/router-utils

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

@tanstack/router-vite-plugin

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

@tanstack/server-functions-plugin

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

@tanstack/solid-router

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

@tanstack/solid-router-devtools

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

@tanstack/solid-router-ssr-query

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

@tanstack/solid-start

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

@tanstack/solid-start-client

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

@tanstack/solid-start-server

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

@tanstack/start-client-core

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

@tanstack/start-plugin-core

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

@tanstack/start-server-core

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

@tanstack/start-static-server-functions

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

@tanstack/start-storage-context

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

@tanstack/valibot-adapter

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

@tanstack/virtual-file-routes

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

@tanstack/zod-adapter

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

commit: d4a26ee