Improve usability of documentation
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Aptitud para principiantes
- 35/100
- Tipo de issue
- Nueva funcionalidad
- Claridad
- Bastante claro
- Estado de actividad
- Estancado
- Stack tecnológico
- css, javascript
- Área
- design, documentation, frontend
Línea de trabajo
Empieza revisando el diseño y los estilos de las páginas del sitio de documentación; después, compara el TOC y la tipografía con los ejemplos enlazados de Lodash, React, Fluent UI y Flutter. Se considerará terminado cuando la documentación tenga un TOC fijo y contraíble, y un tamaño de fuente y una altura de línea más cómodos en escritorio.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
- Please provide a fixed left sidebar for TOC (Table of Contents). Currently, the TOC scrolls with the content which is uncomfortable. And please use toggles for the main concepts of the TOC. Currently, the user must scroll a lot up and down. For inspiration, look at
- https://lodash.com/docs/4.17.15 (fixed left sidebar with collapsable items for TOC)
- https://reactjs.org/docs/getting-started.html (fixed right sidebar with collapsable items for TOC)
- https://developer.microsoft.com/en-us/fluentui#/controls/web/button (fixed left sidebar with collapsable items for TOC)
- https://flutter.dev/docs (fixed left sidebar with collapsable items for TOC)
- And please consider to use another more readable font for better readability. At least, make the font-size and line-height a little smaller. Currently, the font-size (for desktop) is 16 (and line height is 1.6) which is, in my opinion, very uncomfortable to read. Compare the font (size and line-height) with the others example above (which uses, for example, font-size: 14, line-height: 1.3).
- Lenguaje dominante
- JavaScript
- Estrellas
- 163
- Forks
- 434
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Preparar el entorno
Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de framework7io/framework7-website
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 65/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 58/100
-
Dificultad 3/5 1-2 días Aptitud para principiantes 25/100
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 45/100
-
Dificultad 1/5 1-3 horas Aptitud para principiantes 58/100
Todos los issues de framework7io/framework7-website
Issues similares
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 65/100
daisy/a11y-meta-viewer#18 ·
-
good first issue status: needs triaging type: bug version: 2.0
Dificultad 2/5 1-3 horas Aptitud para principiantes 85/100
medusajs/medusa#17094 · 2 comentarios ·
Los mantenedores suelen responder en 1 día
-
browser: chrome package: @carbon/react package: styles
Dificultad 1/5 Menos de una hora Aptitud para principiantes 92/100
carbon-design-system/carbon#23567 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 88/100
clerk/javascript#10033 ·
Los mantenedores suelen responder en 1 día
-
bug client p1
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
vercel/eve#4173 · 2 comentarios ·
Los mantenedores suelen responder en 1 día