reactjs / reactjs/react.dev

[Suggestion]: Glossary of React-specific jargon/concepts

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

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

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

説明

Summary

Create a new page with a glossary of React-specific jargon/concepts.

Page

https://react.dev/learn/glossary or https://react.dev/reference/glossary

Details

The React ecosystem has many React-specific jargon/concepts that may not translate directly into Plain English. Having a glossary of terms will make it easier to introduce new concepts, revamp existing pages, and explain React concepts without duplicating explanations across multiple reference pages.

Some recent examples where a glossary could be helpful:

  • In the Revamp useOptimistic docs pr #8264, there was extensive discussion of Transitions vs Actions vs Transition or Actions. Also, there is some positionally confusing linking of the actions section in the useTransition hook.
  • In the useEffectEvent revamp pr #8279, the Event Effect concept could use a definition, so the page can focus on the hook.
  • Introduce or soft launch new ideas like Async React, Action Props, etc., when the full docs are not ready or known, so educators and learners can speak the same language.

With the recent additions of LLMS.txt #8267 and Claud files #8280, LLMs can provide a first pass at creating a glossary and identify potential areas where other documentation is weak.

Here is a quick sample glossary I created leveraging LLMs https://github.com/MaxwellCohen/cheat-sheets/blob/main/react/react-glossary.md

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

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

はじめの一歩

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

調査の方向性

まず、提案されている用語集の配置場所、既存の React ドキュメント、リンク先の用語集サンプルを確認します。useOptimistic と useEffectEvent の議論で言及されている用語を比較し、そのうえで、ドキュメント内の重複した説明を減らす新しい用語集ページの範囲と構成を定義します。

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

評価

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

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

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