Added Docs site #150
Merged
Added Docs site #150
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
Added GitHub Action for building and deploying docfx site to GitHub Pages
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 PR adds a documentation site, hosted on GitHub pages using DocFX.
The sample site can viewed on my current fork - StreamDeckToolkit
There is an Articles section which can include how the tool has been built, how to build your own actions etc.
The API section is a browser for the code.
The site is being built automatically with a GitHub Action build-docs.yml which uses 3 steps:
It would be great to get some ideas on what we'd like in the documentation, I've currently added the initial pages from the README and template write up.
Thanks,
Linked Issues