🚀📄 Adds Build & Deployment of Documentation #30
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
brucificus
force-pushed
the
generate-docs
branch
from
1eb6e0a
to
026915a
Compare
FGS-BMarkham
force-pushed
the
generate-docs
branch
from
026915a
to
3b4329f
Compare
|
Too early with that squirrel :/, :gopher: |
This adds a project that serves as a surrogate host for the `DocFx` documentation builder. The project is purposefully not added to the `sln`, as it is not a requirement of `DocFx` to do so and adding it would slow development builds. For more information, see: https://dotnet.github.io/docfx/tutorial/docfx_getting_started.html#3-use-docfx-integrated-with-visual-studio
Most of this is auto-generated by DocFx. It was only necessary to tweak the input paths and patterns in order to get a basic documentation build working.
This will help make sure we don't suffer a regression in our documentation builds.
This adds a workflow that builds & deploys our API documentation to the `gh-pages` branch, triggered by every change to the `master` branch.
brucificus
force-pushed
the
generate-docs
branch
from
3b4329f
to
5969f2e
Compare
fgsahoward
approved these changes
Dec 9, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds the generation of documentation using DocFx & the automatic deployment of the output using a GitHub action.
This helps make sure our APIs have publicly-readable (and linkable!) documentation, while also giving us a way to extend it with Markdown if we'd like.