Skip to content

docs: fix broken links - #8470

Open
kurekszymon wants to merge 1 commit into
TanStack:mainfrom
kurekszymon:docs/fix-broken-links
Open

kurekszymon wants to merge 1 commit into
TanStack:mainfrom
kurekszymon:docs/fix-broken-links

Conversation

@kurekszymon

@kurekszymon kurekszymon commented Sep 19, 2026

Copy link
Copy Markdown
Contributor
  • router-core: remove extra /router/ segment from notFound @link
  • router-cli, router-plugin READMEs: point to /docs/installation/with-router-cli
  • setup-basic-search-params: point removed zodValidator/valibotValidator API pages to the Zod/Valibot sections of the search-params guide
  • solid getting-started: drop nonexistent start-bare example
  • .gitignore: update GitHub ignore-files docs URL

🎯 Changes

when reading docs I noticed a broken link, asked local llm to check for more broken links and fixed those where I had high confidence of a proper fix. removed redundant ones

✅ Checklist

  • I have followed the steps in the Contributing guide.
  • I have tested code changes locally with the relevant test commands, or tests do not apply to this pull request.
  • I fully understand the code in this pull request, including any code generated with AI assistance.

🚀 Release Impact

  • This change affects published code, and I have generated a changeset.
  • This change is docs/CI/dev-only (no release).

Summary by CodeRabbit

  • Documentation
    • Updated links to GitHub’s current ignore-file documentation.
    • Corrected search-parameters guide links for TanStack Zod and Valibot adapters.
    • Updated Router CLI and plugin documentation links to the current installation page.
    • Updated the notFound API reference link.
    • Removed the Bare example from the Solid getting-started examples list.

- router-core: remove extra `/router/` segment from notFound @link
- router-cli, router-plugin READMEs: point to /docs/installation/with-router-cli
- setup-basic-search-params: point removed zodValidator/valibotValidator API pages to the Zod/Valibot sections of the search-params guide
- solid getting-started: drop nonexistent start-bare example
- .gitignore: update GitHub ignore-files docs URL
@coderabbitai

coderabbitai Bot commented Sep 19, 2026

Copy link
Copy Markdown
Contributor

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository: TanStack/router/.coderabbit.yaml

Review profile: CHILL

Plan: Advanced

Run ID: 5e619a33-4dc3-4fd2-9e43-c2e09e15e2ae

📥 Commits

Reviewing files that changed from the base of the PR and between ac223be and e767cad.

📒 Files selected for processing (6)
  • .gitignore
  • docs/router/how-to/setup-basic-search-params.md
  • docs/start/framework/solid/getting-started.md
  • packages/router-cli/README.md
  • packages/router-core/src/not-found.ts
  • packages/router-plugin/README.md
💤 Files with no reviewable changes (1)
  • docs/start/framework/solid/getting-started.md

Included review availability: Your plan provides up to 10 included reviews per hour; 9 remain after this review.


📝 Walkthrough

Walkthrough

The pull request updates documentation URLs, changes two search-parameter references to local anchors, and removes the Solid Bare example from the getting-started list. No runtime behavior or public declarations change.

Changes

Documentation maintenance

Layer / File(s) Summary
Documentation link corrections
.gitignore, docs/router/how-to/setup-basic-search-params.md, packages/router-cli/README.md, packages/router-core/src/not-found.ts, packages/router-plugin/README.md
Updated external documentation URLs, changed search-parameter references to local guide anchors, and corrected the notFound API link.
Solid example list
docs/start/framework/solid/getting-started.md
Removed the Bare (start-bare) example from the listed examples.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other

Suggested reviewers: sheraff

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 1 functions across 1 files. (4 skipped: 4 …
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.
Title check ✅ Passed The title clearly and concisely summarizes the main change: fixing broken documentation links.
Description check ✅ Passed The description lists the affected links and documentation updates, explains the motivation, completes the checklist, and correctly marks the change as docs-only with no release impact.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create a new PR

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant