Skip to content

docs(start): compare deferred hydration to Astro islands#7438

Merged
tannerlinsley merged 1 commit into
mainfrom
taren/great-kapitsa-48cac0
May 19, 2026
Merged

docs(start): compare deferred hydration to Astro islands#7438
tannerlinsley merged 1 commit into
mainfrom
taren/great-kapitsa-48cac0

Conversation

@tannerlinsley
Copy link
Copy Markdown
Member

@tannerlinsley tannerlinsley commented May 19, 2026

Summary

  • Adds a short "Comparison To Astro Islands" section to the deferred hydration guide, framing the inverted defaults (Astro: static-first, opt in per island; Start: interactive-first, opt out per Hydrate boundary).
  • Highlights the substrate difference — Astro composes independent runtimes, Start schedules a single React tree — which is why Start gets interaction(), condition(), and intent bubbling, and why Astro gets multi-framework.
  • Mirrored to the Solid guide via a 'one React tree' → 'one Solid tree' transform.

Test plan

  • Render the docs site locally and confirm the new section appears between "Choose What To Defer" and "The Three Decisions" in both React and Solid variants.
  • Confirm the Solid variant reads "one Solid tree" via the transform.

Summary by CodeRabbit

  • Documentation
    • Added "Comparison To Astro Islands" section explaining deferred hydration approach in React framework guide
    • Updated Solid framework guide for consistency

Review Change Stack

Adds a short mental-model section answering the common question
about how TanStack Start's deferred hydration relates to Astro
islands.
@github-actions github-actions Bot added the documentation Everything documentation related label May 19, 2026
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 19, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: b931eb6a-e310-425f-a7ea-c7a6780953d7

📥 Commits

Reviewing files that changed from the base of the PR and between 60ad69c and 39903e0.

📒 Files selected for processing (2)
  • docs/start/framework/react/guide/deferred-hydration.md
  • docs/start/framework/solid/guide/deferred-hydration.md

📝 Walkthrough

Walkthrough

This PR adds documentation clarifications to the deferred hydration guides. The React guide introduces a new comparison section explaining how TanStack Start's deferred hydration approach differs from Astro islands, while the Solid guide updates framework-specific terminology for consistency.

Changes

Deferred Hydration Guides

Layer / File(s) Summary
Deferred hydration documentation
docs/start/framework/react/guide/deferred-hydration.md, docs/start/framework/solid/guide/deferred-hydration.md
React guide adds a new "Comparison To Astro Islands" section clarifying how TanStack Start's full-document hydration with Hydrate boundaries differs conceptually from Astro's isolated framework islands. Solid guide updates terminology from "one React tree" to "one Solid tree" for framework consistency.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A rabbit hops through docs with glee,
Explaining hydration's mystery!
React meets Astro, side by side,
While Solid trees stretch far and wide.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: adding a comparison section between deferred hydration and Astro islands to the documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch taren/great-kapitsa-48cac0

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

@nx-cloud
Copy link
Copy Markdown
Contributor

nx-cloud Bot commented May 19, 2026

View your CI Pipeline Execution ↗ for commit 39903e0

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

☁️ Nx Cloud last updated this comment at 2026-05-19 21:07:11 UTC

@github-actions
Copy link
Copy Markdown
Contributor

🚀 Changeset Version Preview

8 package(s) bumped directly, 16 bumped as dependents.

🟨 Minor bumps

Package Version Reason
@tanstack/react-start-client 1.167.4 → 1.168.0 Changeset
@tanstack/solid-start-client 1.167.4 → 1.168.0 Changeset
@tanstack/start-client-core 1.169.4 → 1.170.0 Changeset
@tanstack/start-plugin-core 1.170.6 → 1.171.0 Changeset
@tanstack/start-server-core 1.168.4 → 1.169.0 Changeset

🟩 Patch bumps

Package Version Reason
@tanstack/router-core 1.171.2 → 1.171.3 Changeset
@tanstack/router-plugin 1.168.6 → 1.168.7 Changeset
@tanstack/router-utils 1.162.0 → 1.162.1 Changeset
@tanstack/react-router 1.170.4 → 1.170.5 Dependent
@tanstack/react-start 1.168.6 → 1.168.7 Dependent
@tanstack/react-start-rsc 0.1.6 → 0.1.7 Dependent
@tanstack/react-start-server 1.167.4 → 1.167.5 Dependent
@tanstack/router-cli 1.167.5 → 1.167.6 Dependent
@tanstack/router-generator 1.167.5 → 1.167.6 Dependent
@tanstack/router-vite-plugin 1.167.6 → 1.167.7 Dependent
@tanstack/solid-router 1.170.4 → 1.170.5 Dependent
@tanstack/solid-start 1.168.6 → 1.168.7 Dependent
@tanstack/solid-start-server 1.167.4 → 1.167.5 Dependent
@tanstack/start-static-server-functions 1.167.4 → 1.167.5 Dependent
@tanstack/start-storage-context 1.167.4 → 1.167.5 Dependent
@tanstack/vue-router 1.170.4 → 1.170.5 Dependent
@tanstack/vue-start 1.168.6 → 1.168.7 Dependent
@tanstack/vue-start-client 1.167.4 → 1.167.5 Dependent
@tanstack/vue-start-server 1.167.4 → 1.167.5 Dependent

@pkg-pr-new
Copy link
Copy Markdown

pkg-pr-new Bot commented May 19, 2026

More templates

@tanstack/arktype-adapter

npm i https://pkg.pr.new/@tanstack/arktype-adapter@7438

@tanstack/eslint-plugin-router

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

@tanstack/eslint-plugin-start

npm i https://pkg.pr.new/@tanstack/eslint-plugin-start@7438

@tanstack/history

npm i https://pkg.pr.new/@tanstack/history@7438

@tanstack/nitro-v2-vite-plugin

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

@tanstack/react-router

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

@tanstack/react-router-devtools

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

@tanstack/react-router-ssr-query

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

@tanstack/react-start

npm i https://pkg.pr.new/@tanstack/react-start@7438

@tanstack/react-start-client

npm i https://pkg.pr.new/@tanstack/react-start-client@7438

@tanstack/react-start-rsc

npm i https://pkg.pr.new/@tanstack/react-start-rsc@7438

@tanstack/react-start-server

npm i https://pkg.pr.new/@tanstack/react-start-server@7438

@tanstack/router-cli

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

@tanstack/router-core

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

@tanstack/router-devtools

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

@tanstack/router-devtools-core

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

@tanstack/router-generator

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

@tanstack/router-plugin

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

@tanstack/router-ssr-query-core

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

@tanstack/router-utils

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

@tanstack/router-vite-plugin

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

@tanstack/solid-router

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

@tanstack/solid-router-devtools

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

@tanstack/solid-router-ssr-query

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

@tanstack/solid-start

npm i https://pkg.pr.new/@tanstack/solid-start@7438

@tanstack/solid-start-client

npm i https://pkg.pr.new/@tanstack/solid-start-client@7438

@tanstack/solid-start-server

npm i https://pkg.pr.new/@tanstack/solid-start-server@7438

@tanstack/start-client-core

npm i https://pkg.pr.new/@tanstack/start-client-core@7438

@tanstack/start-fn-stubs

npm i https://pkg.pr.new/@tanstack/start-fn-stubs@7438

@tanstack/start-plugin-core

npm i https://pkg.pr.new/@tanstack/start-plugin-core@7438

@tanstack/start-server-core

npm i https://pkg.pr.new/@tanstack/start-server-core@7438

@tanstack/start-static-server-functions

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

@tanstack/start-storage-context

npm i https://pkg.pr.new/@tanstack/start-storage-context@7438

@tanstack/valibot-adapter

npm i https://pkg.pr.new/@tanstack/valibot-adapter@7438

@tanstack/virtual-file-routes

npm i https://pkg.pr.new/@tanstack/virtual-file-routes@7438

@tanstack/vue-router

npm i https://pkg.pr.new/@tanstack/vue-router@7438

@tanstack/vue-router-devtools

npm i https://pkg.pr.new/@tanstack/vue-router-devtools@7438

@tanstack/vue-router-ssr-query

npm i https://pkg.pr.new/@tanstack/vue-router-ssr-query@7438

@tanstack/vue-start

npm i https://pkg.pr.new/@tanstack/vue-start@7438

@tanstack/vue-start-client

npm i https://pkg.pr.new/@tanstack/vue-start-client@7438

@tanstack/vue-start-server

npm i https://pkg.pr.new/@tanstack/vue-start-server@7438

@tanstack/zod-adapter

npm i https://pkg.pr.new/@tanstack/zod-adapter@7438

commit: 39903e0

@tannerlinsley tannerlinsley merged commit ac4b43f into main May 19, 2026
10 checks passed
@tannerlinsley tannerlinsley deleted the taren/great-kapitsa-48cac0 branch May 19, 2026 21:09
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