thoughtbot/Argo

Generate documentation as a part of the release process

Open

#437 建立於 2016年12月5日

在 GitHub 查看
 (0 留言) (0 反應) (0 負責人)Swift (214 fork)batch import
documentationenhancementhelp wanted

倉庫指標

Star
 (3,455 star)
PR 合併指標
 (30 天內沒有已合併 PR)

描述

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.

貢獻者指南

研究方向
調查使用 Jazzy 生成 Swift 文件，然後在發布流程中添加一個腳本，運行 Jazzy 並將輸出提交到 web 目錄以用於 GitHub Pages。
技術棧
swift
領域
documentationrelease
議題類型
功能
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-2 天
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
活躍
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
清晰
前置要求
SwiftGitCI/CD
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
70