brndnmtthws/conky

Improve documentation handling

Open

Aperta il 10 gen 2019

Vedi su GitHub
 (6 commenti) (0 reazioni) (0 assegnatari)C++ (6472 star) (604 fork)batch import
documentationgood first issuehelp wanted

Descrizione

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.

Guida contributor

Tech stack
Nessuno
Dominio
documentation
Tipo issue
feature
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
3-5 days
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
stale
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
clear
Prerequisiti
Familiarity with JekyllGitHub Pages experience
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
30
Direzione di ricerca
Start by exploring the current documentation build system in the repository, looking at the XML/XSL files and any related scripts (e.g., Makefile). Then research Jekyll and GitHub Pages to understand how to structure the new documentation. Review any existing discussions in the issue comments for additional context. Consider creating a prototype or a pull request to gather feedback.