[Suggestion]: Glossary of React-specific jargon/concepts
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- JavaScript
- Sterne
- 11.8k
- Forks
- 7.9k
- Ø Merge
- 1 T. 11 Std.
- Gemergte PRs (30 T.)
- 11
Beschreibung
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
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne mit der Durchsicht der vorgeschlagenen Speicherorte für das Glossar, der vorhandenen React-Dokumentation und des verlinkten Beispielglossars. Vergleiche die in den Diskussionen zu useOptimistic und useEffectEvent erwähnten Begriffe und definiere anschließend den Umfang und die Struktur einer neuen Glossarseite, die doppelte Erklärungen in der Dokumentation reduziert.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- javascript, react
- Bereich
- content, documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Aktivitätsstatus
- Ruhig
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100