python / python/docs-community
Feature: Add right/left n/p keyboard navigation to all Python docs
Personne n'a encore pris cette issue.
- Langage dominant
- Makefile
- Étoiles
- 55
- Forks
- 26
- Métriques de merge des PR
- Aucune PR mergée en 30 j
Description
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
Guide de contribution
Aucun guide de contribution indexé pour ce dépôt
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Commencez par examiner l’audit d’accessibilité lié, la pull request de navigation de devguide et les discussions de l’écosystème Sphinx afin de comprendre les risques mentionnés et les approches existantes. Définissez la portée du chapitre consacré à l’accessibilité de la documentation officielle et la manière dont la navigation avec les touches fléchées et la navigation de style vim avec n/p doivent être évaluées dans les projets de documentation Python ; la finalisation doit fournir des recommandations auxquelles d’autres maintainers pourront se référer.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- python
- Domaine
- accessibility, documentation
- Type d'issue
- Fonctionnalité
- Difficulté
- 5/5
- Temps estimé
- Plus d'une semaine
- Activité
- Calme
- Clarté
- À clarifier
- Accessibilité débutants
- 35/100