brndnmtthws/conky

Improve documentation handling

Open

#762 ouverte le 10 janv. 2019

Voir sur GitHub
 (6 commentaires) (0 réactions) (0 assignés)C++ (604 forks)batch import
documentationgood first issuehelp wanted

Métriques du dépôt

Stars
 (6 472 stars)
Métriques de merge PR
 (Merge moyen 17j 10h) (18 PRs mergées en 30 j)

Description

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.

Guide contributeur

Direction de recherche
Commencez par explorer le système de construction de documentation actuel dans le dépôt, en examinant les fichiers XML/XSL et tout script associé (par exemple, Makefile). Ensuite, étudiez Jekyll et GitHub Pages pour comprendre comment structurer la nouvelle documentation. Passez en revue les discussions existantes dans les commentaires de l'issue pour obtenir un contexte supplémentaire. Envisagez de créer un prototype ou une pull request pour recueillir des retours.
Stack technique
Aucun
Domaine
documentation
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
3-5 jours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Ancienne
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Familiarity with JekyllGitHub Pages experience
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
30