docs(router): align RouteMatch API reference with the current public contract
Open
Beginner friendly
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 15.1k
- Forks
- 1.9k
- Avg merge
- 1d 20h
- Merged PRs (30d)
- 143
Description
Goal
Bring the RouteMatch API reference in line with the current public contract.
Scope
- Remove obsolete
showPendingandfetchedAtentries fromdocs/router/api/router/RouteMatchType.md. - Add
fullPathusing its route-specific type,Route['fullPath']. - Add
indexand explain its ordering within the matched route array. - Update
causeto include'preload'. - Keep internal and lifecycle-specific match state out of the reference, including
displayPendingPromise,fetchCount,preload,invalid,headers, andglobalNotFound. - Review the complete page against
packages/router-core/src/Matches.tsso the reference describes the intentional public API.
Related Work
This continues the RouteMatch reference update started in #4894
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with docs/router/api/router/RouteMatchType.md and compare it against packages/router-core/src/Matches.ts, using the public contract described in the issue as the guide. Remove obsolete and internal fields, add the specified public fields and cause value, and review the complete page for accuracy. Done means the reference matches the intentional public RouteMatch API without lifecycle-only state.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 78/100