docs: resolve invalid relative paths #5111

nlynzaad · 2025-09-09T12:28:06Z

paths in "migrate from react location" and "migrate from react-router" to the installation docs form installing Tanstack router returns 404.

This PR fixes the incorrect relative paths.

Summary by CodeRabbit

Documentation
- Updated installation guide links in the React migration guides for TanStack Router to point to the correct “How to Install” page.
- Ensures migration steps reference the right documentation, improving navigation for users following the guides.
- No functional or code changes.

coderabbitai · 2025-09-09T12:28:14Z

Walkthrough

Two React framework documentation files were edited to update relative links to the How to Install TanStack Router guide, changing ./how-to/install.md to ../how-to/install.md. No other content, code, or public APIs were modified.

Changes

Cohort / File(s)	Summary of Changes
Docs link path update `docs/router/framework/react/migrate-from-react-location.md`, `docs/router/framework/react/migrate-from-react-router.md`	Updated relative install guide links from `./how-to/install.md` to `../how-to/install.md`. No other changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Suggested labels

documentation

Pre-merge checks (3 passed)

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title Check	✅ Passed	The title succinctly identifies that documentation files are being updated to resolve invalid relative paths, which matches the primary change in the PR.
Description Check	✅ Passed	The description directly references the incorrect relative paths in the specified documentation pages and states that this PR corrects them, which aligns with the actual changeset.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

Poem

A hop, a skip, a link made right,
I nibble paths by moonlit night—
One dot more, the route aligned,
Docs now point where stars are signed.
Thump-thump! The links are neat;
Carrot cached, review complete. 🥕

Tip

👮 Agentic pre-merge checks are now available in preview!

Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.

Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

Example:

reviews:
  pre_merge_checks:
    custom_checks:
      - name: "Undocumented Breaking Changes"
        mode: "warning"
        instructions: |
          Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).

Please share your feedback with us on this Discord post.

📜 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 d939463 and 60d3738.

📒 Files selected for processing (2)

docs/router/framework/react/migrate-from-react-location.md (1 hunks)
docs/router/framework/react/migrate-from-react-router.md (1 hunks)

🔇 Additional comments (3)

docs/router/framework/react/migrate-from-react-router.md (2)

10-10: Good fix — relative path now resolves correctly.

Moving from ./how-to/install.md to ../how-to/install.md matches this file’s directory depth (react → framework/how-to). Should eliminate the 404.

10-10: Target the correct install guide location

The install.md file for React is located at docs/router/framework/react/how-to/install.md (not docs/router/framework/how-to/install.md), so update your repo-wide link-check commands to reference the correct path.

Likely an incorrect or invalid review comment.

docs/router/framework/react/migrate-from-react-location.md (1)

25-25: Looks correct — link depth matches folder structure.

../how-to/install.md is the right relative path from react/* to framework/how-to/install.md.

✨ Finishing Touches

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch docs-fix-404-links

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

nx-cloud · 2025-09-09T12:28:34Z

View your CI Pipeline Execution ↗ for commit 60d3738

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-09-09 12:28:57 UTC

pkg-pr-new · 2025-09-09T12:29:42Z

More templates

@tanstack/arktype-adapter

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

@tanstack/directive-functions-plugin

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

@tanstack/eslint-plugin-router

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

@tanstack/history

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

@tanstack/react-router

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

@tanstack/react-router-devtools

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

@tanstack/react-router-ssr-query

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

@tanstack/react-start

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

@tanstack/react-start-client

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

@tanstack/react-start-plugin

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

@tanstack/react-start-server

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

@tanstack/router-cli

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

@tanstack/router-core

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

@tanstack/router-devtools

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

@tanstack/router-devtools-core

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

@tanstack/router-generator

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

@tanstack/router-plugin

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

@tanstack/router-ssr-query-core

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

@tanstack/router-utils

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

@tanstack/router-vite-plugin

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

@tanstack/server-functions-plugin

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

@tanstack/solid-router

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

@tanstack/solid-router-devtools

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

@tanstack/solid-start

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

@tanstack/solid-start-client

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

@tanstack/solid-start-plugin

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

@tanstack/solid-start-server

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

@tanstack/start-client-core

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

@tanstack/start-plugin-core

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

@tanstack/start-server-core

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

@tanstack/start-server-functions-client

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

@tanstack/start-server-functions-fetcher

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

@tanstack/start-server-functions-server

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

@tanstack/start-storage-context

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

@tanstack/valibot-adapter

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

@tanstack/virtual-file-routes

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

@tanstack/zod-adapter

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

commit: 60d3738

paths in "migrate from react location" and "migrate from react-router" to the installation docs form installing Tanstack router returns 404. This PR fixes the incorrect relative paths.  ## Summary by CodeRabbit * **Documentation** * Updated installation guide links in the React migration guides for TanStack Router to point to the correct “How to Install” page. * Ensures migration steps reference the right documentation, improving navigation for users following the guides. * No functional or code changes.

resolve invalid relative paths

60d3738

github-actions bot added the documentation Everything documentation related label Sep 9, 2025

nlynzaad merged commit a0e4641 into main Sep 9, 2025
5 of 6 checks passed

nlynzaad deleted the docs-fix-404-links branch September 9, 2025 12:30

coderabbitai bot mentioned this pull request Oct 10, 2025

docs: Update Some Router Docs #5443

Merged

coderabbitai bot mentioned this pull request Oct 24, 2025

docs: fix links for decisions on dx #5608

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

docs: resolve invalid relative paths #5111

docs: resolve invalid relative paths #5111

nlynzaad commented Sep 9, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Sep 9, 2025 •

edited

Loading

Uh oh!

nx-cloud bot commented Sep 9, 2025 •

edited

Loading

Uh oh!

pkg-pr-new bot commented Sep 9, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Uh oh!

docs: resolve invalid relative paths #5111

docs: resolve invalid relative paths #5111

Conversation

nlynzaad commented Sep 9, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Sep 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Suggested labels

Pre-merge checks (3 passed)

Poem

Uh oh!

nx-cloud bot commented Sep 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pkg-pr-new bot commented Sep 9, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

nlynzaad commented Sep 9, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Sep 9, 2025 •

edited

Loading

nx-cloud bot commented Sep 9, 2025 •

edited

Loading