thoughtbot/Argo

Generate documentation as a part of the release process

Open

#437 opened on 2016年12月5日

GitHub で見る
 (0 comments) (0 reactions) (0 assignees)Swift (3,455 stars) (214 forks)batch import
documentationenhancementhelp wanted

説明

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.

コントリビューターガイド

技術スタック
swift
領域
documentation
Issue 種別
feature
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
half day
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
stale
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
clear
前提条件
SwiftJazzyrelease process
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
40
調査方針
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.
Generate documentation as a part of the release process · thoughtbot/Argo#437 | Good First Issue