reactjs / reactjs/react.dev

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

Đang mở
#8,282 2 bình luận 2 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

type: documentation
Ngôn ngữ chính
JavaScript
Star
11.8k
Fork
7.9k
Merge trung bình
1 ngày 11 giờ
Pull request đã merge (30 ngày)
11

Mô tả

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

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Hướng nghiên cứu

Bắt đầu bằng cách xem xét các vị trí được đề xuất cho bảng chú giải, tài liệu React hiện có và bảng chú giải mẫu được liên kết. So sánh các thuật ngữ được đề cập trong các cuộc thảo luận về useOptimistic và useEffectEvent, sau đó xác định phạm vi và cấu trúc của một trang bảng chú giải mới nhằm giảm các phần giải thích trùng lặp trong tài liệu.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ
javascript, react
Lĩnh vực
content, documentation
Loại issue
Tài liệu
Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức độ hoạt động
Ít trao đổi
Độ rõ ràng
Khá rõ ràng
Mức phù hợp với người mới
35/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.