thoughtbot/Argo

Generate documentation as a part of the release process

Open

#437 aberto em 5 de dez. de 2016

Ver no GitHub
 (0 comments) (0 reactions) (0 assignees)Swift (214 forks)batch import
documentationenhancementhelp wanted

Métricas do repositório

Stars
 (3.455 stars)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

Description

It'd be dope if we could automatically generate project documentation (via Jazzy probably?) as a part of the release process and add it to the web directory so that we can serve it with GitHub pages.

Guia do colaborador

Direção de pesquisa
Investigue o uso do Jazzy para gerar documentação Swift e adicione um script ao processo de release que execute o Jazzy e faça commit da saída no diretório web para o GitHub Pages.
Pilha de tecnologia
swift
Domain
documentationrelease
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.
1-2 dias
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
SwiftGitCI/CD
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70