Skip to content

Conversation

@nlynzaad
Copy link
Contributor

@nlynzaad nlynzaad commented Sep 24, 2025

corrects broken links in the start docs

Summary by CodeRabbit

  • Documentation
    • Updated numerous cross‑reference links across React start guides (authentication, execution model, server functions, environment variables, middleware, router guides, migration) to point to correct locations.
    • Hosting guide: added a Netlify section with setup example; updated Cloudflare Workers and Railway/Node.js anchors for clarity.
    • Authentication docs: minor formatting tweaks.
    • Server routes: removed merge conflict markers and cleaned content.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Sep 24, 2025

Walkthrough

This PR updates documentation link targets across multiple React framework docs, adds a new Netlify section and related adjustments to the hosting guide, and cleans up a merge conflict in the server-routes doc. No API, exported entities, or runtime behavior changed.

Changes

Cohort / File(s) Summary of Changes
React docs link path normalization
docs/start/framework/react/authentication-overview.md, docs/start/framework/react/authentication.md, docs/start/framework/react/code-execution-patterns.md, docs/start/framework/react/environment-variables.md, docs/start/framework/react/migrate-from-next-js.md
Updated internal documentation links: many ./ paths changed to ../, some references switched to absolute routes under /router/latest/.... Minor formatting tweak (blockquote) in authentication.md. No content/logic changes.
Hosting guide updates
docs/start/framework/react/hosting.md
Adjusted deployment anchors (references to Cloudflare Pages → Cloudflare Workers, updated Railway/Node.js anchors), added a new Netlify section with a plugin/config example, and small formatting edits.
Server routes cleanup
docs/start/framework/react/server-routes.md
Updated cross-reference for "The Server Entry Point" to ../server-entry-point and removed unresolved merge conflict markers in the "Setting headers in the response" section.

Sequence Diagram(s)

(omitted — changes are documentation-only and do not alter control flow)

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

I twitch my ears and hop through text,
I nudge the paths where links connect.
A Netlify nook I tuck in tight,
Cloudflare footprints set just right.
Conflict cleared — I thump with cheer, 🐇✨

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 "docs(start): fix broken links" accurately and concisely summarizes the primary change, which updates many documentation link targets within the docs/start framework/react pages. It follows conventional commit-style formatting and is clear to reviewers scanning history. Minor edits in the PR (removed merge conflict markers and a small Netlify addition) are secondary and do not make the title misleading.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch start-broken-links

📜 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 d808067 and 4221bbf.

📒 Files selected for processing (2)
  • docs/start/framework/react/hosting.md (3 hunks)
  • docs/start/framework/react/server-routes.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • docs/start/framework/react/hosting.md
  • docs/start/framework/react/server-routes.md

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

@github-actions github-actions bot added the documentation Everything documentation related label Sep 24, 2025
@nx-cloud
Copy link

nx-cloud bot commented Sep 24, 2025

View your CI Pipeline Execution ↗ for commit 4221bbf

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

☁️ Nx Cloud last updated this comment at 2025-09-24 01:14:36 UTC

@pkg-pr-new
Copy link

pkg-pr-new bot commented Sep 24, 2025

More templates

@tanstack/arktype-adapter

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

@tanstack/directive-functions-plugin

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

@tanstack/eslint-plugin-router

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

@tanstack/history

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

@tanstack/nitro-v2-vite-plugin

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

@tanstack/react-router

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

@tanstack/react-router-devtools

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

@tanstack/react-router-ssr-query

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

@tanstack/react-start

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

@tanstack/react-start-client

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

@tanstack/react-start-server

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

@tanstack/router-cli

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

@tanstack/router-core

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

@tanstack/router-devtools

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

@tanstack/router-devtools-core

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

@tanstack/router-generator

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

@tanstack/router-plugin

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

@tanstack/router-ssr-query-core

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

@tanstack/router-utils

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

@tanstack/router-vite-plugin

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

@tanstack/server-functions-plugin

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

@tanstack/solid-router

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

@tanstack/solid-router-devtools

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

@tanstack/solid-start

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

@tanstack/solid-start-client

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

@tanstack/solid-start-server

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

@tanstack/start-client-core

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

@tanstack/start-plugin-core

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

@tanstack/start-server-core

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

@tanstack/start-static-server-functions

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

@tanstack/start-storage-context

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

@tanstack/valibot-adapter

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

@tanstack/virtual-file-routes

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

@tanstack/zod-adapter

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

commit: 4221bbf

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 11

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
docs/start/framework/react/server-routes.md (1)

454-478: Unresolved merge conflict markers and broken code fence.

The section contains conflict markers and a malformed code block. This will break the page render.

Apply this fix to resolve the conflict and restore the example:

   ```ts
   // routes/hello.ts
   import { createFileRoute } from '@tanstack/react-router'
-
-  <<<<<<< HEAD
-  =======
-  ```
-
-  > > > > > > > 582e8c7a1 (docs: Start overhaul)
-  > > > > > > > export const Route = createFileRoute('/hello')({
-
+  export const Route = createFileRoute('/hello')({
     server: {
       handlers: {
         GET: async ({ request }) => {
           return new Response('Hello, World!', {
             headers: {
               'Content-Type': 'text/plain',
             },
           })
         },
       },
     },
-
-})
-
-// Visit /hello to see the response
-// Hello, World!
-
-````
+  })
+
+  // Visit /hello to see the response
+  // Hello, World!
+  ```
📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c2f732d and d808067.

📒 Files selected for processing (7)
  • docs/start/framework/react/authentication-overview.md (1 hunks)
  • docs/start/framework/react/authentication.md (2 hunks)
  • docs/start/framework/react/code-execution-patterns.md (2 hunks)
  • docs/start/framework/react/environment-variables.md (1 hunks)
  • docs/start/framework/react/hosting.md (3 hunks)
  • docs/start/framework/react/migrate-from-next-js.md (1 hunks)
  • docs/start/framework/react/server-routes.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/environment-variables.md
  • docs/start/framework/react/migrate-from-next-js.md
  • docs/start/framework/react/code-execution-patterns.md
  • docs/start/framework/react/hosting.md
  • docs/start/framework/react/authentication-overview.md
  • docs/start/framework/react/authentication.md
  • docs/start/framework/react/server-routes.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/environment-variables.md
  • docs/start/framework/react/migrate-from-next-js.md
  • docs/start/framework/react/code-execution-patterns.md
  • docs/start/framework/react/hosting.md
  • docs/start/framework/react/authentication-overview.md
  • docs/start/framework/react/authentication.md
  • docs/start/framework/react/server-routes.md
🧠 Learnings (1)
📚 Learning: 2025-09-23T17:36:12.589Z
Learnt from: CR
PR: TanStack/router#0
File: AGENTS.md:0-0
Timestamp: 2025-09-23T17:36:12.589Z
Learning: Applies to docs/**/*.{md,mdx} : Use internal docs links relative to the docs/ folder (e.g., ./guide/data-loading)

Applied to files:

  • docs/start/framework/react/code-execution-patterns.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 (1)
docs/start/framework/react/hosting.md (1)

21-28: Duplicate Cloudflare bullet — remove duplicate & standardize anchor
Two identical cloudflare-pages bullets link to #cloudflare-workers; remove the duplicate in docs/start/framework/react/hosting.md (lines 21–28) and standardize the Cloudflare target across the docs (choose cloudflare-pages, cloudflare-workers, or cloudflare-module).

@nlynzaad nlynzaad merged commit 065722a into main Sep 24, 2025
6 checks passed
@nlynzaad nlynzaad deleted the start-broken-links branch September 24, 2025 01:18
@coderabbitai coderabbitai bot mentioned this pull request Oct 15, 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.

2 participants