python / python/python-docs-theme

Docs Python.org button

Open Beginner friendly
#217 7 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Documentation

Below 1024 pixels width there is no button that returns you to the docs home.

Image


For screen widths > 1023 you can click the "3.13.1 Documentation »" button to return to the docs index.

Image

Proposal

When using the docs on a small screen there is no easy way to return to the index as you can see in the below page:

Image

I propose for usability the Python logo returns you to the index, this is generally the web standard.

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.

Research direction

Start by inspecting the theme's responsive documentation header and navigation around the breakpoint below 1024 pixels. Check how the Python logo and the desktop “3.13.1 Documentation »” link are wired, then verify that the logo returns to the documentation index on small screens as well as wide screens.

Written by the indexing model from the issue text.

Assessment

Tech stack
css
Domain
documentation, frontend
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.