thoughtbot/Argo

Generate documentation as a part of the release process

Open

#437 opened on Dec 5, 2016

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Swift (214 forks)batch import
documentationenhancementhelp wanted

Repository metrics

Stars
 (3,455 stars)
PR merge metrics
 (No merged PRs in 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.

Contributor guide

Research direction
Investigate using Jazzy to generate Swift documentation, then add a script to the release process that runs Jazzy and commits the output to the web directory for GitHub Pages.
Tech stack
swift
Domain
documentationrelease
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
SwiftGitCI/CD
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70