python / python/python-docs-theme

Implement collapsable navigation menus like Wikipedia on moblie

Aperta
#245 3 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Lingua principale
CSS
Stelle
90
Fork
78
Merge medio
2g 19h
PR unite (30g)
4

Descrizione

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.

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia esaminando il markup dell'indice del tema e gli stili di navigazione mobile, quindi confronta il layout annidato attuale con la navigazione comprimibile di Wikipedia. Definisci come devono espandersi e comprimersi le intestazioni sui dispositivi mobili, incluse le sezioni del changelog, e verifica il risultato in una build della documentazione con dimensioni da mobile.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
css
Ambito
documentation, frontend
Tipo di issue
Funzionalità
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.