[Suggestion]: Glossary of React-specific jargon/concepts
Nessuno ha ancora preso questa issue.
- Lingua principale
- JavaScript
- Stelle
- 11.8k
- Fork
- 7.9k
- Merge medio
- 1g 11h
- PR unite (30g)
- 11
Descrizione
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
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia esaminando le posizioni proposte per il glossario, la documentazione React esistente e il glossario di esempio collegato. Confronta i termini menzionati nelle discussioni su useOptimistic e useEffectEvent, quindi definisci l’ambito e la struttura di una nuova pagina del glossario che riduca le spiegazioni duplicate nella documentazione.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- javascript, react
- Ambito
- content, documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Stato di attività
- Tranquilla
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 35/100