void-linux / void-linux/void-docs

Single-page version of Handbook?

Aperta
#243 8 commenti 3 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

enhancement help wanted
Lingua principale
CSS
Stelle
217
Fork
212
Merge medio
2g 21h
PR unite (30g)
1

Descrizione

Can/should we provide a single-page version of the Handbook? A user on IRC asked if there was one, and it seems to me that it would make it easier for users to search for particular terms within the Handbook.

Related: the above user noted that it was annoying to go to a page in the Handbook and find that it contained only a brief overview of the section. In a single-page version, i imagine this would be fine; but if we started adding ToCs for subsections (cf. https://github.com/void-linux/void-docs/pull/234), that might end up being unwieldy in a single-page version.

@ericonr, @bobertlo, thoughts?

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

Esamina il codice sorgente di Handbook e l’approccio all’indice delle sottosezioni discusso in PR #234. Decidi se è desiderato un Handbook su un’unica pagina e come la relativa navigazione debba gestire i contenuti delle sottosezioni; il lavoro è considerato completato quando l’ambito e il formato dell’output sono concordati prima dell’implementazione.

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

Valutazione

Ambito
documentation
Tipo di issue
Funzionalità
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Da chiarire
Idoneità per principianti
20/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.