reactjs / reactjs/react.dev

More granular linking in docs

Đang mở
#6,038 3 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ả

This is a feature request.
I think it would be very useful to be able to link to specific paragraphs or callouts, etc.
For example, in the image below, I can't link the actual pitfall, rather, I can only link the the top level header that contains it, several paragraphs up.

Making more things linkable will make the docs much more interactive, in my opinion. I would be able to point people to specific bits of information.

image

I don't think that there is one simple rule that can be applied for this obviously, because many paragraphs can't be taken in without more context. But maybe some heuristics can be applied to cover a large percentage of the content.

Is this the right place for this feature request? Will you accept PRs for this? Is there some accessiblity concern I'm unaware of?

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

Issue không nêu tên tệp, bài kiểm thử hoặc điểm vào nào. Hãy bắt đầu bằng cách xác định hành vi hiện tại của các liên kết tiêu đề trên trang tài liệu và xem xét cách các đoạn văn và callout được render. Công việc được xem là hoàn tất khi đã xác định và triển khai một cách tiếp cận nhất quán, dễ tiếp cận để liên kết đến nội dung cụ thể, cùng với việc bao quát các ví dụ tài liệu tiêu biể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
documentation
Loại issue
Tính năng
Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Cần làm rõ
Mức phù hợp với người mới
30/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.