Implement collapsable navigation menus like Wikipedia on moblie

Open
#245 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
css
Domain
documentation, frontend

Research direction

Start by inspecting the theme's table-of-contents markup and mobile navigation styles, then compare the current nested layout with Wikipedia's collapsible navigation. Define how headings should expand and collapse on mobile, including the changelog sections, and verify the result in a mobile-sized documentation build.

Written by the indexing model from the issue text.

Description

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.

Dominant language
CSS
Stars
90
Forks
78
Avg merge
2d 19h
Merged PRs (30d)
4

Contributor guide

Open the contributing guide

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.

More from python/python-docs-theme

All issues in python/python-docs-theme

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.