[Suggestion]: Glossary of React-specific jargon/concepts
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 11.8k
- Forks
- 7.9k
- Avg merge
- 1d 11h
- Merged PRs (30d)
- 11
Description
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
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the proposed glossary locations, the existing React documentation, and the linked sample glossary. Compare the terms mentioned in the useOptimistic and useEffectEvent discussions, then define the scope and structure of a new glossary page that reduces duplicated explanations across the docs.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, react
- Domain
- content, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100