Skip to content

docs: small improvements to wording - #7840

Merged
schiller-manuel merged 1 commit into
TanStack:mainfrom
sajadtorkamani:patch-1
Jul 17, 2026
Merged

docs: small improvements to wording#7840
schiller-manuel merged 1 commit into
TanStack:mainfrom
sajadtorkamani:patch-1

Conversation

@sajadtorkamani

@sajadtorkamani sajadtorkamani commented Jul 17, 2026

Copy link
Copy Markdown
Contributor

Summary by CodeRabbit

  • Documentation
    • Normalized formatting in two sections of the router documentation without changing the content or meaning.
    • Updated a manual installation instruction line while preserving the same text for setting the index.html root element.

@sajadtorkamani sajadtorkamani changed the title docs: improvements to wording docs: small improvements to wording Jul 17, 2026
@coderabbitai

coderabbitai Bot commented Jul 17, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 1345ab3a-e3f6-43f4-ba2c-252485f1ffc0

📥 Commits

Reviewing files that changed from the base of the PR and between 933014a and 43bdf7c.

📒 Files selected for processing (2)
  • docs/router/decisions-on-dx.md
  • docs/router/installation/manual.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/router/decisions-on-dx.md

📝 Walkthrough

Walkthrough

Three router documentation lines were rewritten with identical visible wording, resulting in formatting-only changes.

Changes

Documentation normalization

Layer / File(s) Summary
Normalize router documentation
docs/router/decisions-on-dx.md, docs/router/installation/manual.md
Existing DX explanations, the “Route tree stitching” item, and the index.html root element instruction were re-applied without semantic text changes.

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

Suggested labels: documentation

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The title is broadly related to documentation changes, but it is vague and doesn't reflect that the diffs are effectively no-op formatting rewrites. Use a more specific title that states the actual change, such as formatting or whitespace normalization in router docs.
✅ 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.

Comment thread docs/router/decisions-on-dx.md Outdated

1. **Route configuration boilerplate**: It generates the boilerplate for your route configurations.
2. **Route tree stitching**: It stitches together your route configurations into a single cohesive route-tree. Also in the background, it correctly updates the route configurations to define the `getParentRoute` function match the routes with their parent routes.
2. **Route tree stitching**: It stitches together your route configurations into a single cohesive route-tree. Also in the background, it correctly updates the route configurations to define the `getParentRoute` function and so match the routes with their parent routes.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

"and so matchES" ?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Thanks - have updated accordingly 🙏

@schiller-manuel
schiller-manuel merged commit 6184661 into TanStack:main Jul 17, 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