brndnmtthws/conky

Improve documentation handling

Open

#762 aberto em 10 de jan. de 2019

Ver no GitHub
 (6 comments) (0 reactions) (0 assignees)C++ (604 forks)batch import
documentationgood first issuehelp wanted

Métricas do repositório

Stars
 (6.472 stars)
Métricas de merge de PR
 (Mesclagem média 17d 10h) (18 fundiu PRs em 30d)

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.

Guia do colaborador

Direção de pesquisa
Comece explorando o sistema de construção de documentação atual no repositório, examinando os arquivos XML/XSL e quaisquer scripts relacionados (por exemplo, Makefile). Em seguida, pesquise sobre Jekyll e GitHub Pages para entender como estruturar a nova documentação. Revise quaisquer discussões existentes nos comentários da issue para obter contexto adicional. Considere criar um protótipo ou uma pull request para coletar feedback.
Pilha de tecnologia
None
Domain
documentation
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
3-5 dias
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Antigo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Familiarity with JekyllGitHub Pages experience
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
30