brndnmtthws/conky

Improve documentation handling

Open

#762 geöffnet am 10. Jan. 2019

Auf GitHub ansehen
 (6 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)C++ (604 Forks)batch import
documentationgood first issuehelp wanted

Repository-Metriken

Stars
 (6.472 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 17T 10h) (18 gemergte PRs in 30 T)

Beschreibung

I'd like to convert the documentation from a XML/XSL-based system, to a simpler JSON/Jekyll/Jinja2 based system. I would also like to use GitHub pages to provide a landing page with documentation for Conky.

Contributor Guide

Research-Richtung
Beginnen Sie damit, das aktuelle Dokumentations Build System im Repository zu erkunden, indem Sie die XML/XSL Dateien und alle zugehörigen Skripte (z. B. Makefile) betrachten. Erforschen Sie dann Jekyll und GitHub Pages, um zu verstehen, wie die neue Dokumentation strukturiert werden soll. Überprüfen Sie vorhandene Diskussionen in den Issue Kommentaren für zusätzlichen Kontext. Erwägen Sie, einen Prototyp oder einen Pull Request zu erstellen, um Feedback zu sammeln.
Tech Stack
Keine
Domain
documentation
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
3-5 Tage
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Veraltet
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Familiarity with JekyllGitHub Pages experience
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
30