thoughtbot/Argo

Generate documentation as a part of the release process

Open

#437 aperta il 5 dic 2016

Vedi su GitHub
 (0 commenti) (0 reazioni) (0 assegnatari)Swift (214 fork)batch import
documentationenhancementhelp wanted

Metriche repository

Star
 (3455 star)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Investiga l'uso di Jazzy per generare documentazione Swift, quindi aggiungi uno script al processo di rilascio che esegue Jazzy e committa l'output nella directory web per GitHub Pages.
Tech stack
swift
Dominio
documentationrelease
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-2 giorni
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
SwiftGitCI/CD
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70