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.