python / python/docs-community

Feature: Add right/left n/p keyboard navigation to all Python docs

Open
#199 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Makefile
Stars
55
Forks
26
PR merge metrics
No merged PRs in 30d

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

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the linked accessibility audit, devguide navigation pull request, and Sphinx ecosystem discussions to understand the stated risks and existing approaches. Define the scope of the official documentation accessibility chapter and how arrow-key and vim-style n/p navigation should be evaluated across Python documentation projects; completion should provide guidance that other maintainers can reference.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
accessibility, documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.