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 (3,455 stars) (214 forks)batch import
documentationenhancementhelp wanted

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

Tech stack
swift
Domain
documentation
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.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
SwiftJazzyrelease process
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Investigate the existing release process in the repository (likely via Rakefile or Makefile). Look into Jazzy documentation generation and how to integrate it into the release workflow. Check the 'web' directory if it exists and understand how GitHub Pages serves documentation. There are no comments or PRs on this issue, so the exact implementation details are open.