docs: `createLink` has no API reference page; 3 how-to guides link to a missing `#createlink` anchor
I maintainer di solito rispondono entro 1 giorno
Valutazione
- Difficoltà
- 2/5
- Tempo stimato
- 1-3 ore
- Idoneità per principianti
- 88/100
- Tipo di issue
- Documentazione
- Chiarezza
- Specificata chiaramente
- Stato di attività
- Attiva
- Stack tecnologico
- react, typescript
- Ambito
- documentation
Direzione di ricerca
Leggi le pagine di riferimento delle funzioni esistenti in docs/router/api/router/ e l’esportazione createLink in packages/react-router/src/index.tsx. Aggiungi docs/router/api/router/createLinkFunction.md, inseriscila in Functions in docs/router/api/router.md e aggiorna i link nelle tre guide pratiche indicate. Il lavoro è completato quando la pagina di riferimento esiste e tutti e tre i link puntano ad essa.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Which project does this relate to?
Router
Describe the bug
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.mdline 822docs/router/how-to/integrate-material-ui.mdline 716docs/router/how-to/integrate-shadcn-ui.mdline 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. - Point the three how-to links to the new page.
I'd like to work on this and open a PR.
Complete minimal reproducer
Steps to Reproduce the Bug
- Open
docs/router/how-to/integrate-chakra-ui.mdand go to line 822 (the "Related Resources" section). The same link is inintegrate-material-ui.mdline 716 andintegrate-shadcn-ui.mdline 516. - See the link
[TanStack Router createLink API](../api/router#createlink). - Open
docs/router/api/router.md: there is nocreateLinkentry 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.
Screenshots or Videos
No response
Platform
N/A, documentation issue
- Router version: main branch (commit d9b07e8)
Additional context
No response
- Lingua principale
- TypeScript
- Stelle
- 15.2k
- Fork
- 1.9k
- Merge medio
- 1g 13h
- PR unite (30g)
- 76
Preparare l'ambiente
Avvia il container di sviluppo del progetto nel browser, con il tuo account GitHub.
- Nessun Dockerfile né file Docker Compose
- Ha un modello di pull request
- Leggi la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di TanStack/router
-
router.startViewTransition leaves the ready/finished promises unhandled, so a skipped transition throws an unhandled AbortErrorForse già presa @unjica l’ha presa 2 giorni fa. Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 74/100
TanStack/router#8776 · 3 commenti · 1 reazione ·
I maintainer di solito rispondono entro 1 giorno
-
Router devtools crash when search params contain a BigInt (JSON.stringify in history tracking)Forse già presa @A-Raphie l’ha presa 6 giorni fa. Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 76/100
I maintainer di solito rispondono entro 1 giorno
-
Inline scripts are duplicated after hydration when the CSP nonce is sent in a headerForse già presa @gabriel-le l’ha presa 27 giorni fa. Aperta
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 90/100
I maintainer di solito rispondono entro 1 giorno
-
start-plugin-core: sitemap lastmod and pages.json lastBuilt are stamped with the build's wall clock (no SOURCE_DATE_EPOCH support)Forse già presa @treadnot l’ha presa 28 giorni fa. Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 84/100
I maintainer di solito rispondono entro 1 giorno
-
Empty .ts route file is scaffolded with JSX, breaking all route generationForse già presa @nathan-logan l’ha presa 32 giorni fa. Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
I maintainer di solito rispondono entro 1 giorno
Tutte le issue di TanStack/router
Issue simili
-
freshness freshness:observed-only
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
thoroc/context-radar#282 ·
-
bug P2 rust
Difficoltà 2/5 1-3 ore Idoneità per principianti 82/100
I maintainer di solito rispondono entro 1 giorno
-
area: web
Difficoltà 2/5 1-3 ore Idoneità per principianti 85/100
gabe-santana/arkdraw#25 ·
-
bug require-triage
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
expressjs/expressjs.com#2549 · 1 reazione ·
I maintainer di solito rispondono entro 1 giorno
-
bug good first issue hacktoberfest
Difficoltà 2/5 1-3 ore Idoneità per principianti 88/100
codercops/discord-bot#101 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno