void-linux / void-linux/void-docs

Single-page version of Handbook?

Offen
#243 8 Kommentare 3 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

enhancement help wanted
Vorherrschende Sprache
CSS
Sterne
217
Forks
212
Ø Merge
2 T. 21 Std.
Gemergte PRs (30 T.)
1

Beschreibung

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?

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Überprüfe den Quelltext von Handbook und den in PR #234 diskutierten Ansatz für ein Inhaltsverzeichnis der Unterabschnitte. Entscheide, ob ein Handbook auf einer einzigen Seite gewünscht ist und wie seine Navigation mit den Inhalten der Unterabschnitte umgehen soll; als abgeschlossen gilt die Aufgabe, wenn Umfang und Ausgabeformat vor der Implementierung vereinbart sind.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Bereich
documentation
Issue-Typ
Feature
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
20/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.