django/djangoproject.com

Documentation table of contents is hard to reach on mobile devices

Open

#494 opened on Jun 26, 2015

View on GitHub
 (6 comments) (2 reactions) (0 assignees)Python (1,100 forks)user submission
accessibilitydocsgood first issue

Repository metrics

Stars
 (2,001 stars)
PR merge metrics
 (Avg merge 7d 6h) (16 merged PRs in 30d)

Description

On mobile devices the table of contents appears at the bottom of the page, making it very hard to reach. So if you're looking for a specific thing you have to swipe all your way through the page to reach it.

It would be way better to have it on top of the documentation pages. I guess it could be collapsed by default so that it doesn't take too much room.

Contributor guide

Research direction
Examine the documentation page templates (likely in `djangoproject/templates/docs/`) to locate the table of contents element. Investigate current CSS and JavaScript that handles mobile layout. Implement a solution that moves the TOC to the top of the page on mobile devices and makes it collapsible by default. Test on various mobile viewport sizes.
Tech stack
pythondjangohtmlcssjavascript
Domain
documentationfrontend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
HTML/CSSJavaScriptResponsive design principles
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80