-
-
Notifications
You must be signed in to change notification settings - Fork 1.3k
docs(start): fix broken links #5197
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
WalkthroughThis 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
Sequence Diagram(s)(omitted — changes are documentation-only and do not alter control flow) Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (2)
🚧 Files skipped from review as they are similar to previous changes (2)
Comment |
|
View your CI Pipeline Execution ↗ for commit 4221bbf
☁️ Nx Cloud last updated this comment at |
More templates
@tanstack/arktype-adapter
@tanstack/directive-functions-plugin
@tanstack/eslint-plugin-router
@tanstack/history
@tanstack/nitro-v2-vite-plugin
@tanstack/react-router
@tanstack/react-router-devtools
@tanstack/react-router-ssr-query
@tanstack/react-start
@tanstack/react-start-client
@tanstack/react-start-server
@tanstack/router-cli
@tanstack/router-core
@tanstack/router-devtools
@tanstack/router-devtools-core
@tanstack/router-generator
@tanstack/router-plugin
@tanstack/router-ssr-query-core
@tanstack/router-utils
@tanstack/router-vite-plugin
@tanstack/server-functions-plugin
@tanstack/solid-router
@tanstack/solid-router-devtools
@tanstack/solid-start
@tanstack/solid-start-client
@tanstack/solid-start-server
@tanstack/start-client-core
@tanstack/start-plugin-core
@tanstack/start-server-core
@tanstack/start-static-server-functions
@tanstack/start-storage-context
@tanstack/valibot-adapter
@tanstack/virtual-file-routes
@tanstack/zod-adapter
commit: |
There was a problem hiding this 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
📒 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.mddocs/start/framework/react/migrate-from-next-js.mddocs/start/framework/react/code-execution-patterns.mddocs/start/framework/react/hosting.mddocs/start/framework/react/authentication-overview.mddocs/start/framework/react/authentication.mddocs/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.mddocs/start/framework/react/migrate-from-next-js.mddocs/start/framework/react/code-execution-patterns.mddocs/start/framework/react/hosting.mddocs/start/framework/react/authentication-overview.mddocs/start/framework/react/authentication.mddocs/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 identicalcloudflare-pagesbullets 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 (choosecloudflare-pages,cloudflare-workers, orcloudflare-module).
corrects broken links in the start docs
Summary by CodeRabbit