morelinq/MoreLINQ

Add continuous documentation build

Open

#417 opened on Mar 21, 2018

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

Repository metrics

Stars
 (3,495 stars)
PR merge metrics
 (No merged PRs in 30d)

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

Research direction
Configure AppVeyor to install Sandcastle Help File Builder and run builddocs.cmd on each push to master, then publish the generated documentation.
Tech stack
csharp
Domain
devopsdocumentation
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.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
GitCI/CD basicsSandcastle Help File Builder
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60