reactjs / reactjs/react.dev

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

Aberta
#8,282 2 comentários 2 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

type: documentation
Linguagem predominante
JavaScript
Estrelas
11.8k
Forks
7.9k
Merge médio
1d 11h
PRs com merge (30d)
11

Descrição

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

Guia de contribuição

Abrir o guia de contribuição

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Direção de pesquisa

Comece revisando os locais propostos para o glossário, a documentação existente do React e o glossário de exemplo vinculado. Compare os termos mencionados nas discussões sobre useOptimistic e useEffectEvent e, em seguida, defina o escopo e a estrutura de uma nova página de glossário que reduza as explicações duplicadas na documentação.

Escrita pelo modelo de indexação a partir do texto da issue.

Avaliação

Stack de tecnologia
javascript, react
Domínio
content, documentation
Tipo de issue
Documentação
Dificuldade
5/5
Tempo estimado
Mais de uma semana
Status de atividade
Pouca atividade
Clareza
Razoavelmente clara
Facilidade para iniciantes
35/100

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.