brndnmtthws/conky

Improve documentation handling

Ouverte

#762 ouverte le 10 janv. 2019

Voir sur GitHub
 (6 commentaires) (0 réaction) (0 personne assignée)C++ (666 forks)batch import
documentationgood first issuehelp wanted

Métriques du dépôt

Stars
 (8 477 étoiles)
Métriques de merge PR
 (Merge moyen 2j) (17 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
Examinez les fichiers de documentation XML/XSL existants, comprenez la structure et apprenez Jekyll et Jinja2 pour concevoir un nouveau système base sur JSON.
Stack technique
rubypython
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.
1-2 jours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
GitGitHub Pages
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75