thoughtbot/Argo

Generate documentation as a part of the release process

开放

#437 创建于 2016年12月5日

在 GitHub 查看贡献者指南
 (0 条评论) (0 个反应) (0 位负责人)Swift (214 个派生)batch import
documentationenhancementhelp wanted

仓库指标

星标
 (3,455 个星标)
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