python / python/docs-community
Feature: Add right/left n/p keyboard navigation to all Python docs
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- Makefile
- Star
- 55
- Fork
- 26
- Chỉ số merge pull request
- Không có pull request nào được merge trong 30 ngày
Mô tả
Describe the enhancement or feature you would like
Right now the accessibility audit https://github.com/python/devguide/issues/1792 is blocking keyboard navigation https://github.com/python/devguide/pull/1784 not only for devguide, but across Python ecosysem https://github.com/orgs/sphinx-doc/discussions/14406 https://github.com/sphinx-doc/sphinx/pull/14408 https://github.com/readthedocs/sphinx_rtd_theme/pull/1686 https://github.com/pradyunsg/furo/discussions/932
Clearly, other projects may not have the resources to access the risk of hurting sensitive auditory, so all maintainers just don't take it - and while Sphinx comes with keyboard shortcuts, no project across Pyto ecosystem enables it.
Now that there is a chance to do accessibility study, please make sure that both arrow keys and vim `style n/p keys are evaluated for usage, with official "documentation accessibility" chapter, that could be easily referenced for other projects to follow.
Thanks for your time, folks.
Describe alternatives you have considered
No response
Additional context
No response
Hướng dẫn đóng góp
Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này
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 bằng việc xem xét audit khả năng truy cập được liên kết, pull request về điều hướng của devguide và các cuộc thảo luận trong hệ sinh thái Sphinx để hiểu các rủi ro đã nêu và những cách tiếp cận hiện có. Xác định phạm vi của chương về khả năng truy cập trong tài liệu chính thức và cách đánh giá việc điều hướng bằng phím mũi tên cũng như điều hướng kiểu vim bằng n/p trên các dự án tài liệu Python; khi hoàn thành, cần cung cấp hướng dẫn mà các maintainer khác có thể tham khảo.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- python
- Lĩnh vực
- accessibility, 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
- Ít trao đổi
- Độ rõ ràng
- Cần làm rõ
- Mức phù hợp với người mới
- 35/100