python / python/docs-community
Feature: Add right/left n/p keyboard navigation to all Python docs
Nessuno ha ancora preso questa issue.
- Lingua principale
- Makefile
- Stelle
- 55
- Fork
- 26
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Descrizione
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
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia esaminando l’audit di accessibilità collegato, la pull request sulla navigazione di devguide e le discussioni dell’ecosistema Sphinx per comprendere i rischi indicati e gli approcci esistenti. Definisci l’ambito del capitolo sull’accessibilità della documentazione ufficiale e come valutare la navigazione con i tasti freccia e quella in stile vim con n/p nei progetti di documentazione Python; il completamento dovrebbe fornire indicazioni a cui altri maintainer possano fare riferimento.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- python
- Ambito
- accessibility, documentation
- Tipo di issue
- Funzionalità
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Stato di attività
- Tranquilla
- Chiarezza
- Da chiarire
- Idoneità per principianti
- 35/100