Skip to content

Conversation

fulopkovacs
Copy link
Contributor

@fulopkovacs fulopkovacs commented Oct 7, 2025

I updated the docs and examples about streaming data from server functions in #5363 (comment), but I messed it up and the new docs page went to the router's docs. TanStack Start doesn't have a Guides section yet, so I moved the new page to the Getting Started section of Start.

Summary by CodeRabbit

  • Documentation
    • Corrected the Streaming section link in the React Server Functions guide to ensure it navigates to the intended page.
    • Improves documentation navigation and reduces broken-link friction for readers.
    • No changes to application behavior or APIs.
    • Clarifies the path structure for related streaming content, making it easier to follow learning flow.
    • Minor editorial adjustment only; users can browse the updated docs without any action required.

…Stack Start doesn't have a "Guides" section yet
@github-actions github-actions bot added the documentation Everything documentation related label Oct 7, 2025
Copy link

nx-cloud bot commented Oct 7, 2025

View your CI Pipeline Execution ↗ for commit bdc54ed

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-07 20:33:44 UTC

Copy link
Contributor

coderabbitai bot commented Oct 7, 2025

Walkthrough

Updates a single documentation file to correct the relative link for the Streaming section, changing the path from ../guide/streaming-data-from-server-functions to ../streaming-data-from-server-functions.

Changes

Cohort / File(s) Summary
Docs link fix
docs/start/framework/react/server-functions.md
Adjusted relative link for the Streaming section from ../guide/streaming-data-from-server-functions to ../streaming-data-from-server-functions.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

Poem

A nibble of docs, a hop through the trees,
I fixed a small path with whiskered ease.
No routes were harmed, no code in fright—
Just streaming now pointed right.
Bunny approves, with a twitch of delight. 🐇✨

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 concisely and accurately describes the primary change in this PR by stating that streaming docs are moved to the Getting Started section. It clearly summarizes the main action without including unrelated details or file paths, making it fully relevant to the changeset. Although it includes the reason for the move, this does not undermine its clarity or specificity.
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

📜 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 a5fdf29 and bdc54ed.

📒 Files selected for processing (1)
  • docs/start/framework/react/server-functions.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/react/server-functions.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/react/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.

Copy link

pkg-pr-new bot commented Oct 7, 2025

More templates

@tanstack/arktype-adapter

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

@tanstack/directive-functions-plugin

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

@tanstack/eslint-plugin-router

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

@tanstack/history

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

@tanstack/nitro-v2-vite-plugin

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

@tanstack/react-router

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

@tanstack/react-router-devtools

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

@tanstack/react-router-ssr-query

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

@tanstack/react-start

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

@tanstack/react-start-client

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

@tanstack/react-start-server

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

@tanstack/router-cli

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

@tanstack/router-core

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

@tanstack/router-devtools

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

@tanstack/router-devtools-core

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

@tanstack/router-generator

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

@tanstack/router-plugin

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

@tanstack/router-ssr-query-core

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

@tanstack/router-utils

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

@tanstack/router-vite-plugin

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

@tanstack/server-functions-plugin

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

@tanstack/solid-router

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

@tanstack/solid-router-devtools

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

@tanstack/solid-start

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

@tanstack/solid-start-client

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

@tanstack/solid-start-server

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

@tanstack/start-client-core

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

@tanstack/start-plugin-core

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

@tanstack/start-server-core

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

@tanstack/start-static-server-functions

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

@tanstack/start-storage-context

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

@tanstack/valibot-adapter

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

@tanstack/virtual-file-routes

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

@tanstack/zod-adapter

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

commit: bdc54ed

@schiller-manuel schiller-manuel changed the title Move the streaming docs to the "Getting started" section, because TanStack Start doesn't have a "Guides" section yet docs: Move the streaming docs to the "Getting started" section, because TanStack Start doesn't have a "Guides" section yet Oct 8, 2025
@schiller-manuel schiller-manuel merged commit 09ddae9 into TanStack:main Oct 8, 2025
6 checks passed
LadyBluenotes pushed a commit to LadyBluenotes/router that referenced this pull request Oct 10, 2025
…se TanStack Start doesn't have a "Guides" section yet (TanStack#5399)

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
LadyBluenotes pushed a commit to LadyBluenotes/router that referenced this pull request Oct 10, 2025
…se TanStack Start doesn't have a "Guides" section yet (TanStack#5399)

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
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.

2 participants