reactjs / reactjs/react.dev

Suggestion: Link each mention of a React API to the reference docs

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

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

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

説明

I'm new to React and just started reading the documentation.

I noticed that references to the API are not links, just plain text. It would be helpful if they were actual links to the API.

Example: On this page https://reactjs.org/docs/rendering-elements.html it says:

image

The yellow API reference should actually be a link to the ReactDOM.render(), meaning a link to https://reactjs.org/docs/react-dom.html#render.
This helps me a lot because I can easily discover the complete reference of that function, the complete list and description of the parameters, function behaviors, different possible usage, etc.
As I go through the documentation and concepts, I can quickly go back and forth between concepts and API reference. It's much quicker to have links I can open in a new tab, instead of manually searching in the API reference every time.

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

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

はじめの一歩

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

調査の方向性

issue で示されているレンダリング要素のドキュメントページから始め、プレーンテキストの ReactDOM.render() 参照を見つけます。周辺のドキュメントを確認し、同じ対応が必要なほかの API への言及を探します。これらの参照が対応する API リファレンスページにリンクされていれば完了です。

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

評価

技術スタック
javascript, react
領域
documentation
issue の種類
ドキュメント
難易度
3/5
見積もり時間
1〜2日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
35/100

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

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