python / python/python-docs-theme
new navigation sidebar is effectively modal, keyboard-hostile, and hides the documentation from view
未关闭
还没有人认领这个 Issue。
- 主要语言
- CSS
- 星标
- 90
- 派生
- 78
- 平均合并
- 2 天 19 小时
- 30 天内合并 PR
- 4
描述
The not-yet-released python 3.10 and 3.11 docs theme introduces navigation sidebar behavior that is several steps backwards in usability. From what I can tell, it exhibits all these problems:
- When open, it covers up the documentation instead of letting the text reflow, making it impossible to follow my usual workflow of quickly jumping from one section to the next while reading the bits I need. The experience is like trying to navigate around modal dialog boxes in a 1990s Windows application.
- It is now inaccessible on systems without a mouse.
- Even on computers that have a mouse, viewing it is now a hassle. One must locate the mysterious hamburger button, move a hand to the mouse, aim it at the button, and click it, before the menu will appear at all. Only then can one go about looking for a needed navigation link. That's a lot of extra steps compared to simply having the links always available at the top, bottom, or side of the page.
- Scrolling through the navigation links no longer works without a mouse. Page Up/Down, arrow keys, and space bar all fail to scroll the content being read. Only mouse navigation seems to be supported.
This new design seems to have been implemented hastily, without consideration for users outside a very narrow range of workflows and devices. Please revert it, at least until something more sensible can be developed.
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
调研方向
该 issue 指出了 Python 3.10 和 3.11 文档主题中的新导航侧边栏;首先找到该侧边栏的实现,并复现其鼠标和键盘行为。完成的标准应是:在导航过程中文档仍然可用,侧边栏不会遮挡文本,并且键盘用户可以访问和滚动导航内容。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- css
- 领域
- accessibility, documentation
- Issue 类型
- 缺陷
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 35/100