Skip to content

Conversation

@kellenproctor
Copy link
Contributor

@kellenproctor kellenproctor commented Oct 14, 2025

Making the 'Combining Prefixes and Suffixes' section clearer by making the text and code example suffix the same ('.json' all the way through, instead of '.json' vs 'person')

Summary by CodeRabbit

  • Documentation
    • Updated the Path Params guide example to use a .json suffix in combined prefix/suffix routes.
    • Route example changed from '/users/user-{$userId}person' to '/users/user-{$userId}.json'.
    • Clarifies that the captured userId ends before '.json'.
    • Improves clarity for defining dynamic segments with surrounding static text.

Making the 'Combining Prefixes and Suffixes' section clearer by making the text and code example suffix the same ('.json' all the way through, instead of '.json' vs 'person')
@github-actions github-actions bot added the documentation Everything documentation related label Oct 14, 2025
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 14, 2025

Walkthrough

Updated the React router Path Params guide example: changed the route suffix from "person" to ".json" and adjusted the explanation to state the captured userId ends before ".json". No code or API changes.

Changes

Cohort / File(s) Summary of Changes
Docs: React Router Path Params Guide
docs/router/framework/react/guide/path-params.md
Updated example route to use a ".json" suffix and revised the descriptive text about where userId capture ends.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

I twitch my whiskers, paths align,
From “person” trails to “.json” sign.
A hop, a dot, a tidy end—
The params now precisely blend.
I stamp my paw—docs crisp and done,
Route crumbs gathered, on to the next run! 🐇✨

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)
Check name Status Explanation Resolution
Title Check ❓ Inconclusive The title “typo: Update path-params.md” notes a file update but is too generic and does not summarize the key change of aligning the example suffix from “person” to “.json” for clarity. It fails to convey the substantive content of the PR. Consider revising the title to clearly describe the main change, for example “Clarify path-params.md example by using consistent ‘.json’ suffix” so that the intent is immediately clear.
✅ Passed checks (2 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 changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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 and usage tips.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
docs/router/framework/react/guide/path-params.md (1)

190-190: Nit: prefer “Route:” label over file-like comment

To avoid implying a filename (since .json isn’t a filesystem extension here) and to align with other examples that use “Route:”, consider:

-// src/routes/users/user-{$userId}.json
+// Route: /users/user-{$userId}.json
📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 294b82a and 3e6fbfc.

📒 Files selected for processing (1)
  • docs/router/framework/react/guide/path-params.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/router/framework/react/guide/path-params.md
docs/{router,start}/**

📄 CodeRabbit inference engine (AGENTS.md)

Place router docs under docs/router/ and start framework docs under docs/start/

Files:

  • docs/router/framework/react/guide/path-params.md
🔇 Additional comments (1)
docs/router/framework/react/guide/path-params.md (1)

190-191: Consistency fix LGTM

Using .json in both the path and explanation is clear and consistent with the section intent.

Also applies to: 197-197

@schiller-manuel schiller-manuel merged commit 6cc67e5 into TanStack:main Oct 14, 2025
2 checks passed
@kellenproctor kellenproctor deleted the patch-2 branch October 14, 2025 21:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Everything documentation related

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants