python / python/docs-community
Feature: Add right/left n/p keyboard navigation to all Python docs
まだ誰も着手していません。
- 主要言語
- Makefile
- スター
- 55
- フォーク
- 26
- PR マージ指標
- 30日以内にマージされた PR はありません
説明
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
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
リンクされているアクセシビリティ監査、devguide のナビゲーションに関するプルリクエスト、Sphinx エコシステムでの議論をまず確認し、指摘されているリスクと既存のアプローチを理解します。公式ドキュメントのアクセシビリティ章の範囲と、Python ドキュメントプロジェクト全体で矢印キーによるナビゲーションおよび vim スタイルの n/p ナビゲーションをどのように評価すべきかを定義します。完了時には、他のメンテナーが参照できるガイダンスを提供できるようにします。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- python
- 領域
- accessibility, documentation
- issue の種類
- 機能追加
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 活発さ
- 静か
- 明瞭さ
- 説明が足りない
- 初心者へのやさしさ
- 35/100