nodejs / nodejs/node

Render "About this documentation" as the landing page for the documentation section

Đang mở
#60,667 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
122k
Fork
37.3k
Merge trung bình
4 ngày 2 giờ
Pull request đã merge (30 ngày)
283

Mô tả

URL:

https://nodejs.org/docs/latest/api/

Browser Name:

Safari

Browser Version:

26.0.1 (21622.1.22.11.15)

Operating System:

MacOS 26.0.1

How to reproduce the issue:

Upon opening the documentation page, the user sees two table of contents, one in the navigation bar and one as the landing page as shown here:

Image

I think it would be more visually consistent if the landing page were “About this documentation.” Such as this snapshot below:

Image

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 mở https://nodejs.org/docs/latest/api/ và so sánh landing page hiện tại với chế độ xem “About this documentation” được đề xuất trong issue. Truy vết entry point của tài liệu tạo ra trang này, sau đó xác nhận rằng navigation và landing page không còn hiển thị các mục lục dư thừa.

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
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
Ít trao đổi
Độ rõ ràng
Khá rõ ràng
Mức phù hợp với người mới
55/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.