Within-section navigation missing for smaller screens, global contents difficult to navigate.
Nessuno ha ancora preso questa issue.
- Lingua principale
- Python
- Stelle
- 77.2k
- Fork
- 35.9k
- Metriche di merge delle PR
- Metriche PR in attesa
Descrizione
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
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia esaminando la navigazione della barra laterale della documentazione, l’indice globale e gli URL delle sezioni come /{version}/tutorial/interpreter.html e /{version}/tutorial/. Il lavoro è completato quando gli schermi stretti identificano la sezione corrente, forniscono la navigazione per tornare ai contenuti della sezione, i ToC delle sezioni rimandano al ToC globale e il maxdepth del ToC globale è limitato a 2. Nell’issue è già referenziata una pull request collegata.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- python
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 25/100