python / python/python-docs-theme

Implement collapsable navigation menus like Wikipedia on moblie

オープン
#245 コメント 3 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

主要言語
CSS
スター
90
フォーク
78
平均マージ
2日 19時間
マージ済み PR(30日)
4

説明

The Python documentation table of contents is massive. It's unwieldy on a mobile device. A lot of that comes from itemising all the changelogs going back to 3.0 release. In and of itself, that's fine, but it takes a lot of scrolling to find anything. The indentation also isn't terribly clear to identify what is a subheading of what. Highly nested headings exacerbates this.

Collapsable TOC headings, used on sites like Wikipedia, would help tremendously with this. That way, mobile users could see a cleaner layout resembling the desktop TOC display, then be able to drill down into whatever topic they're looking for.

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

まず、テーマの目次のマークアップとモバイルナビゲーションのスタイルを調査し、現在の入れ子構造のレイアウトを Wikipedia の折りたたみ可能なナビゲーションと比較します。changelog のセクションを含め、モバイルで見出しをどのように展開・折りたたみするかを定義し、モバイルサイズのドキュメントビルドで結果を確認します。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
css
領域
documentation, frontend
issue の種類
機能追加
難易度
4/5
見積もり時間
3〜5日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
35/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。