thoughtbot/Argo

Generate documentation as a part of the release process

Ouverte

#437 ouverte le 5 déc. 2016

Voir sur GitHubGuide contributeur
 (0 commentaire) (0 réaction) (0 personne assignée)Swift (214 forks)batch import
documentationenhancementhelp wanted

Métriques du dépôt

Stars
 (3 455 étoiles)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

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.

Guide contributeur

Direction de recherche
Étudiez l'utilisation de Jazzy pour générer la documentation Swift, puis ajoutez un script au processus de release qui exécute Jazzy et commit la sortie dans le répertoire web pour GitHub Pages.
Stack technique
swift
Domaine
documentationrelease
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
SwiftGitCI/CD
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70