Explore adding top-level "API" link to header nav
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 discussion thread on Twitter provided feedback that the reference section of the docs may not be very discoverable due to the new website's accordion sidebar.
@gaearon proposed we could do something similar to what Jest does and add an "API" link to the header that directly opens the first page of the reference section (eg React Top-Level API).
Unfortunately this is a little more complicated than it would seem at a glance because of:
- How we determine which header link gets the "active" style. If we added a new "API" link, both it and "Docs" would share the same "/docs" URL path. (Jest side-steps this issue by not applying "active" header link styles.)
- We try to maintain symmetry between the location of markdown content (eg content/blog, content/docs) and the top-level nav structure (eg "Blog", "Docs")
Unfortunately we can't rely on anything dynamic (like markdown frontmatter tags) to help with the "active" link styling because the header and footer are part of the "static" Gatsby layout. (Technically we could move them into the templates but this doesn't seem ideal.)
We could move reference docs into a new folder (eg "content/api") give them a unique URL prefix (eg "/api") but we'd need to leave backwards-compatible redirects (eg redirect_from like here) in place so that no bookmarked links were broken. This would also require separating "Docs" and "API" sidebar structure.
Hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- 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.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Hướng nghiên cứu
Bắt đầu với src/components/LayoutHeader/Header.js và cấu trúc content/docs, sau đó xem xét cách liên kết header đang hoạt động hiện tại được xác định. So sánh đề xuất di chuyển /api, các chuyển hướng như redirect_from và cấu trúc sidebar riêng biệt. Công việc được xem là hoàn tất khi một liên kết API trong header mở phần tài liệu tham chiếu mà không làm hỏng các liên kết hiện có hoặc kiểu hiển thị của điều hướng đang hoạt độ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, frontend, web-dev
- 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
- Khá rõ ràng
- Mức phù hợp với người mới
- 35/100