Within-section navigation missing for smaller screens, global contents difficult to navigate.
まだ誰も着手していません。
- 主要言語
- Python
- スター
- 77.2k
- フォーク
- 35.9k
- PR マージ指標
- PR 指標を取得中
説明
Documentation
Problem
Within a documentation section (I'm using that term to refer to sub-documents like, say, the tutorial, not sure if there is an official term), there is currently no way to go "up" a level to see the contents of that section when not using a full width screen:
Full width screens have breadcrumbs at the top
The "table of contents" link takes you back to the global contents, which are not usable, as they contain every header from every document in the docs - take a scroll if you haven't in awhile: https://docs.python.org/3/contents.html
It's also not obvious which document you are in, as "table of contents" is ambiguous - the only place that "tutorial" is present is in the URL.
This makes it quite challenging to navigate the docs on mobile, or when splitting a screen and reading in a narrow window.
Desired solution
I would like...
- the sidebar "Table of Contents" to be replaced with the title of current document section when one is within a document section (eg.
/{version}/tutorial/interpreter.html), and with a link to the global ToC when one is in a section ToC (eg./{version}/tutorial/). - The maxdepth of the global ToC to be reduced to 2 to make it usable
I will follow on with a PR momentarily...
Linked PRs
- gh-123453
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず、ドキュメントのサイドバー ナビゲーション、グローバルな目次、および /{version}/tutorial/interpreter.html や /{version}/tutorial/ などのセクション URL を確認します。狭い画面で現在のセクションを識別でき、そのセクションの目次に戻るナビゲーションを提供し、セクションの ToCs からグローバルな ToC にリンクし、グローバルな ToC の maxdepth を 2 に制限できれば完了です。リンクされた pull request はすでに issue で参照されています。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- python
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 25/100