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.