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

Aperta
#8,282 2 commenti 2 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
35/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Tranquilla
Stack tecnologico
javascript, react
Ambito
content, documentation

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.

Descrizione

type: documentation
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

Lingua principale
JavaScript
Stelle
11.8k
Fork
7.9k
Merge medio
16h 6m
PR unite (30g)
7

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di reactjs/react.dev

Tutte le issue di reactjs/react.dev

Issue simili

Altre issue su JavaScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.