reactjs / reactjs/react.dev

More granular linking in docs

オープン
#6,038 コメント 3 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

主要言語
JavaScript
スター
11.8k
フォーク
7.9k
平均マージ
1日 11時間
マージ済み PR(30日)
11

説明

This is a feature request.
I think it would be very useful to be able to link to specific paragraphs or callouts, etc.
For example, in the image below, I can't link the actual pitfall, rather, I can only link the the top level header that contains it, several paragraphs up.

Making more things linkable will make the docs much more interactive, in my opinion. I would be able to point people to specific bits of information.

image

I don't think that there is one simple rule that can be applied for this obviously, because many paragraphs can't be taken in without more context. But maybe some heuristics can be applied to cover a large percentage of the content.

Is this the right place for this feature request? Will you accept PRs for this? Is there some accessiblity concern I'm unaware of?

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

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

調査の方向性

このIssueでは、ファイル、テスト、エントリーポイントが指定されていません。まず、ドキュメントサイトにおける現在の見出しリンクの動作を特定し、段落とコールアウトがどのようにレンダリングされるかを確認してください。特定のコンテンツにリンクするための一貫性がありアクセシブルなアプローチを定義・実装し、代表的なドキュメント例をカバーできれば完了です。

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

評価

技術スタック
javascript, react
領域
documentation
issue の種類
機能追加
難易度
5/5
見積もり時間
1週間以上
活発さ
停滞
明瞭さ
説明が足りない
初心者へのやさしさ
30/100

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

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