python / python/python-docs-theme

Implement collapsable navigation menus like Wikipedia on moblie

Đang mở
#245 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
CSS
Star
90
Fork
78
Merge trung bình
2 ngày 19 giờ
Pull request đã merge (30 ngày)
4

Mô tả

The Python documentation table of contents is massive. It's unwieldy on a mobile device. A lot of that comes from itemising all the changelogs going back to 3.0 release. In and of itself, that's fine, but it takes a lot of scrolling to find anything. The indentation also isn't terribly clear to identify what is a subheading of what. Highly nested headings exacerbates this.

Collapsable TOC headings, used on sites like Wikipedia, would help tremendously with this. That way, mobile users could see a cleaner layout resembling the desktop TOC display, then be able to drill down into whatever topic they're looking for.

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 kiểm tra markup của mục lục trong theme và các style của điều hướng trên thiết bị di động, sau đó so sánh layout lồng nhau hiện tại với điều hướng có thể thu gọn của Wikipedia. Xác định cách các tiêu đề cần được mở rộng và thu gọn trên thiết bị di động, bao gồm cả các phần changelog, và kiểm tra kết quả trong một bản build tài liệu ở kích thước di độ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ệ
css
Lĩnh vực
documentation, frontend
Loại issue
Tính năng
Độ khó
4/5
Thời gian dự kiến
3-5 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.