Skip to content

docs: minor docs improvements - #7842

Merged
schiller-manuel merged 4 commits into
TanStack:mainfrom
sajadtorkamani:patch-2
Jul 22, 2026
Merged

docs: minor docs improvements#7842
schiller-manuel merged 4 commits into
TanStack:mainfrom
sajadtorkamani:patch-2

Conversation

@sajadtorkamani

@sajadtorkamani sajadtorkamani commented Jul 17, 2026

Copy link
Copy Markdown
Contributor

Summary by CodeRabbit

  • Documentation
    • Rephrased the code-splitting example guidance to clarify the “split your route into two files” explanation.
    • Updated the “Route Trees” section to better explain converting the example into code-based routing.
    • Fixed grammar and punctuation in file-based routing, routing concepts, and navigation for improved readability.
    • Aligned routing guide cross-references and labels for consistency.
    • Refined automatic code-splitting and navigation warning text (wording and style only).

@coderabbitai

coderabbitai Bot commented Jul 17, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review
📝 Walkthrough

Walkthrough

The PR updates router documentation wording, punctuation, and internal guide references across code-splitting and routing pages. No exported entities or routing behavior change.

Changes

Router documentation

Layer / File(s) Summary
Code-splitting guidance
docs/router/guide/code-splitting.md, docs/router/guide/automatic-code-splitting.md
Rephrases .lazy.tsx example guidance and corrects wording in the automatic code-splitting transformation explanation.
Routing terminology and prose consistency
docs/router/routing/*.md, docs/router/guide/navigation.md
Updates guide references, navigation wording, type-safety wording, and punctuation in routing explanations.

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

Possibly related PRs

  • TanStack/router#7840: Documentation-only wording and formatting updates in the TanStack Router documentation.

Suggested labels: documentation

Suggested reviewers: 0x80

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The title is related to the docs-only change, but it is too vague to convey the main updates. Use a more specific title that mentions the router documentation wording and cross-reference fixes.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

@sajadtorkamani
sajadtorkamani force-pushed the patch-2 branch 5 times, most recently from cf45153 to 226c599 Compare July 22, 2026 19:06

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/router/guide/automatic-code-splitting.md`:
- Line 79: Update the sentence describing automatic code splitting to use “in
place” instead of the hyphenated “in-place” wording, leaving the rest of the
sentence unchanged.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 9e91f806-d5ff-4207-80ac-cf95adce6454

📥 Commits

Reviewing files that changed from the base of the PR and between cf45153 and 226c599.

📒 Files selected for processing (2)
  • docs/router/guide/automatic-code-splitting.md
  • docs/router/guide/navigation.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/router/guide/navigation.md

Comment thread docs/router/guide/automatic-code-splitting.md Outdated
@schiller-manuel
schiller-manuel merged commit 2b08d9b into TanStack:main Jul 22, 2026
3 checks passed
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.

2 participants