-
-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Update RouteMatchType.md #5699
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Update RouteMatchType.md #5699
Conversation
add staticData property
WalkthroughDocumentation updated to add a new Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning, 1 inconclusive)
✅ Passed checks (1 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this 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/api/router/RouteMatchType.md (1)
28-28: Add explanation and link for thestaticDataproperty.The new
staticDataproperty is added without any documentation explaining its purpose, when it's populated, or whatStaticDataRouteOptionrepresents. This leaves users unclear about how to use this property.Consider adding:
- An explanation of what
staticDatacontains and its purpose- A link to the
StaticDataRouteOptiontype definition/documentation (using relative doc links per guidelines)- An example showing typical usage
Additionally, clarify whether this property is always present (required) or sometimes absent (optional with
?).
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/router/framework/react/api/router/RouteMatchType.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/api/router/RouteMatchType.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/api/router/RouteMatchType.md
add
staticDataproperty to the RouteMatchTypeSummary by CodeRabbit
New Features
Documentation