Hacktoberfest 2026：メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

docs: `createLink` has no API reference page; 3 how-to guides link to a missing `#createlink` anchor

オープン 初心者向け
  • 何か問題がありますか？
#8,766 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

@A-Raphie がすでに取り組んでいます。

2026年10月19日 から。

  • #8770 @A-Raphie による — オープン

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
88/100
issue の種類
ドキュメント
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
react, typescript
領域
documentation

調査の方向性

docs/router/api/router/ 以下にある既存の関数リファレンスページと、packages/react-router/src/index.tsx の createLink エクスポートを読みます。docs/router/api/router/createLinkFunction.md を追加し、docs/router/api/router.md の Functions に掲載して、指定された3つのハウツーガイドのリンクを更新します。リファレンスページが存在し、3つすべてのリンクがそこを指していれば完了です。

索引モデルが issue の本文から書いたものです。

説明

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.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:

  1. Add docs/router/api/router/createLinkFunction.md, following the format of the other function pages.
  2. List it under "Functions" in docs/router/api/router.md.
  3. Point the three how-to links to the new page.

I'd like to work on this and open a PR.

Complete minimal reproducer

https://github.com/TanStack/router/blob/d9b07e8d3b724cdbfac0aa2fba4c1f7a3a241100/docs/router/how-to/integrate-chakra-ui.md?plain=1#L822

Steps to Reproduce the Bug
  1. 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.
  2. See the link [TanStack Router createLink API](../api/router#createlink).
  3. Open docs/router/api/router.md: there is no createLink entry or heading in the Functions list.
  4. 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

主要言語
TypeScript
スター
15.2k
フォーク
1.9k
平均マージ
1日 13時間
マージ済み PR（30日）
76

環境構築

Codespaces で開く

このプロジェクトの開発コンテナを、あなたの GitHub アカウントでブラウザ上に起動します。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

TanStack/router のほかの issue

TanStack/router の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。