morelinq/MoreLINQ

Add continuous documentation build

Open

#417 创建于 2018年3月21日

在 GitHub 查看
 (0 评论) (0 反应) (0 负责人)C# (3,495 star) (406 fork)batch import
Component-Scriptsdocshelp wanted

描述

The documentation is built on each release. It would nice to see the documentation built and published on each push to master.

The documentation is built via builddocs.cmd. It requires Sandcastle Help File Builder (SHFB) to installed. A compressed archive of SHFB is available for each release that can be downloaded and then installed on an AppVeyor Windows image, perhaps using:

msiexec /i SandcastleHelpFileBuilder.msi /quiet /qn /norestart /log install.log

贡献者指南

技术栈
无
领域
documentationci cd
议题类型
feature
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-2 days
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
mostly clear
前置要求
CI/CD basicsWindows command lineSandcastle Help File Builder
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
40
研究方向
Examine the builddocs.cmd script referenced in the issue to understand the current build process. Consider using GitHub Actions or AppVeyor to automate the build and publish steps. The issue suggests downloading and installing Sandcastle Help File Builder (SHFB) via msiexec on a Windows CI image. Determine where to publish the documentation (e.g., GitHub Pages) and ensure the CI workflow triggers on pushes to master.
Add continuous documentation build · morelinq/MoreLINQ#417 | Good First Issue