You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
docs: createLink has no API reference page; 3 how-to guides link to a missing #createlink anchor #8766
createLink is exported from @tanstack/react-router (packages/react-router/src/index.tsx), but it has no API reference page. Functions like createRoute, linkOptions and redirect each have a page listed in docs/router/api/router.md; createLink is not listed there, and no file under docs/router/api/ mentions it. It is only documented in the Custom Link guide (docs/router/guide/custom-link.md).
Three how-to guides link to it anyway, using an anchor that doesn't exist:
docs/router/how-to/integrate-chakra-ui.md line 822
docs/router/how-to/integrate-material-ui.md line 716
docs/router/how-to/integrate-shadcn-ui.md line 516
Each one is: [TanStack Router createLink API](../api/router#createlink)
There is no createlink heading or entry in docs/router/api/router.md, so the link does not lead to any createLink documentation.
Proposed fix:
Add docs/router/api/router/createLinkFunction.md, following the format of the other function pages.
List it under "Functions" in docs/router/api/router.md.
- [TanStack Router createLink API](../api/router#createlink) - API documentation for component integration
Steps to Reproduce the Bug
Open docs/router/how-to/integrate-chakra-ui.md and go to line 822 (the "Related Resources" section). The same link is in integrate-material-ui.md line 716 and integrate-shadcn-ui.md line 516.
See the link [TanStack Router createLink API](../api/router#createlink).
Open docs/router/api/router.md: there is no createLink entry or heading in the Functions list.
Search docs/router/api/ for "createLink": no results.
Expected behavior
The "TanStack Router createLink API" links lead to an API reference page for createLink, like the pages that exist for createRoute, linkOptions and redirect.
Activity