Within-section navigation missing for smaller screens, global contents difficult to navigate.
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Python
- Sterne
- 77.2k
- Forks
- 35.9k
- PR-Merge-Kennzahlen
- PR-Kennzahlen ausstehend
Beschreibung
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
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne mit der Überprüfung der Navigationsseitenleiste der Dokumentation, des globalen Inhaltsverzeichnisses und von Abschnitts-URLs wie /{version}/tutorial/interpreter.html und /{version}/tutorial/. Die Aufgabe ist erledigt, wenn schmale Bildschirme den aktuellen Abschnitt erkennen lassen, eine Navigation zurück zu den Inhalten dieses Abschnitts bieten, die Abschnitts-ToCs mit dem globalen ToC verknüpft sind und die maximale Tiefe des globalen ToC auf 2 begrenzt ist. Ein verknüpfter pull request wird im Issue bereits referenziert.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 25/100