Improve usability of documentation
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Idoneità per principianti
- 35/100
- Tipo di issue
- Funzionalità
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Ferma
- Stack tecnologico
- css, javascript
- Ambito
- design, documentation, frontend
Direzione di ricerca
Inizia esaminando il layout e gli stili delle pagine del sito della documentazione, quindi confronta il TOC e la tipografia con gli esempi collegati di Lodash, React, Fluent UI e Flutter. Il lavoro sarà considerato completato quando la documentazione avrà un TOC fisso e comprimibile, oltre a una dimensione del carattere e un’altezza della riga più confortevoli su desktop.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
- 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).
- Lingua principale
- JavaScript
- Stelle
- 163
- Fork
- 431
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Preparare l'ambiente
Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.
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.
Altre issue di framework7io/framework7-website
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 65/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 58/100
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 25/100
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 45/100
-
Difficoltà 1/5 1-3 ore Idoneità per principianti 58/100
Tutte le issue di framework7io/framework7-website
Issue simili
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
microsoft/playwright#43327 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
microsoft/TypeScript#64758 ·
I maintainer di solito rispondono entro 1 giorno
-
needs-area-label
Difficoltà 2/5 1-3 ore Idoneità per principianti 82/100
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 65/100
-
bug good first issue help wanted status: planned
Difficoltà 2/5 1-3 ore Idoneità per principianti 88/100
andersthemagi/reliquary#310 ·
I maintainer di solito rispondono entro 1 giorno