morelinq/MoreLINQ

Add continuous documentation build

Open

#417 opened on Mar 21, 2018

View on GitHub
 (0 comments) (0 reactions) (0 assignees)C# (3,495 stars) (406 forks)batch import
Component-Scriptsdocshelp wanted

Description

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

Contributor guide

Tech stack
None
Domain
documentationci cd
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
CI/CD basicsWindows command lineSandcastle Help File Builder
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
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.