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

Abierto
#8,282 2 comentarios 2 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
35/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Tranquilo
Stack tecnológico
javascript, react
Área
content, documentation

Línea de trabajo

Comienza revisando las ubicaciones propuestas para el glosario, la documentación existente de React y el glosario de ejemplo enlazado. Compara los términos mencionados en los debates sobre useOptimistic y useEffectEvent, y luego define el alcance y la estructura de una nueva página de glosario que reduzca las explicaciones duplicadas en la documentación.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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

Lenguaje dominante
JavaScript
Estrellas
11.8k
Forks
7.9k
Merge medio
16 h 6 min
PR fusionados (30 d)
7

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de reactjs/react.dev

Todos los issues de reactjs/react.dev

Issues similares

Más issues de JavaScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.