thoughtbot/Argo

Generate documentation as a part of the release process

Offen

#437 geöffnet am 05.12.2016

Auf GitHub ansehenContributor Guide
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Swift (214 Forks)batch import
documentationenhancementhelp wanted

Repository-Metriken

Stars
 (3.455 Sterne)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

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.

Contributor Guide

Research-Richtung
Untersuchen Sie die Verwendung von Jazzy zur Generierung von Swift Dokumentation und fügen Sie dem Release Prozess ein Skript hinzu, das Jazzy ausführt und die Ausgabe in das Webverzeichnis für GitHub Pages überträgt.
Tech Stack
swift
Domain
documentationrelease
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-2 Tage
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
SwiftGitCI/CD
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70