thoughtbot/Argo

Generate documentation as a part of the release process

Open

#437 建立於 2016年12月5日

在 GitHub 查看
 (0 留言) (0 反應) (0 負責人)Swift (3,455 star) (214 fork)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
議題類型
feature
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
half day
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
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.