python / python/python-docs-theme

Implement collapsable navigation menus like Wikipedia on moblie

Abierto
#245 3 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Lenguaje dominante
CSS
Estrellas
90
Forks
78
Merge medio
2 d 19 h
PR fusionados (30 d)
4

Descripción

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.

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Comienza inspeccionando el marcado de la tabla de contenidos del tema y los estilos de navegación móvil; después, compara el diseño anidado actual con la navegación plegable de Wikipedia. Define cómo deben expandirse y contraerse los encabezados en dispositivos móviles, incluidas las secciones del changelog, y verifica el resultado en una compilación de la documentación con tamaño móvil.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
css
Área
documentation, frontend
Tipo de issue
Nueva funcionalidad
Dificultad
4/5
Tiempo estimado
3-5 días
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
35/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.