reactjs / reactjs/react.dev

Suggestion: Link each mention of a React API to the reference docs

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

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

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ả

I'm new to React and just started reading the documentation.

I noticed that references to the API are not links, just plain text. It would be helpful if they were actual links to the API.

Example: On this page https://reactjs.org/docs/rendering-elements.html it says:

image

The yellow API reference should actually be a link to the ReactDOM.render(), meaning a link to https://reactjs.org/docs/react-dom.html#render.
This helps me a lot because I can easily discover the complete reference of that function, the complete list and description of the parameters, function behaviors, different possible usage, etc.
As I go through the documentation and concepts, I can quickly go back and forth between concepts and API reference. It's much quicker to have links I can open in a new tab, instead of manually searching in the API reference every time.

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 với trang tài liệu về các phần tử rendering được nêu trong issue và tìm tham chiếu ReactDOM.render() ở dạng văn bản thuần túy. Xem lại phần tài liệu xung quanh để tìm các đề cập API khác cần được xử lý tương tự; hoàn tất khi các tham chiếu đó liên kết đến các trang tham chiếu API tương ứng.

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
documentation
Loại issue
Tài liệu
Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức độ hoạt động
Đình trệ
Độ 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.