python / python/python-docs-theme

Implement collapsable navigation menus like Wikipedia on moblie

Ouverte
#245 3 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Langage dominant
CSS
Étoiles
90
Forks
78
Merge moyen
2 j 19 h
PR mergées (30 j)
4

Description

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.

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par examiner le balisage de la table des matières du thème et les styles de navigation mobile, puis comparez la mise en page imbriquée actuelle avec la navigation repliable de Wikipedia. Définissez comment les titres doivent se développer et se réduire sur mobile, y compris les sections du changelog, et vérifiez le résultat dans un build de documentation au format mobile.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
css
Domaine
documentation, frontend
Type d'issue
Fonctionnalité
Difficulté
4/5
Temps estimé
3-5 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
35/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.