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.
Background
I think this repo is getting a lot of deserved attention, a nice doc as code site will help others with How to, FAQ, Cool use cases etc..., The mkdocs site is the most simple doc as code framework in my opinion and it's python! So using this framework would let the repo connect a GitHub site without managing anything separate. All pages are in friendly markdown and the theme is very well supported and packed with nifty features.
I think this would encourage others share there successes on the repo and site and really spur each other on. It is also a cool way for non coding folks to make meaningful contributions. I personally love to find a well documented software, it makes me smile. I often need hand holding.
Adding the site to the repository could be done with github actions:
A how to is found here: https://squidfunk.github.io/mkdocs-material/publishing-your-site/
Changes
Added mkdocs.yml
Added docs folder ->
index.md landing page
Added docs/documentation folder ->
added getting_started.md
Added docs/contributors folder ->
added contributors.md
Updated the requirements to include mkdocs and mkdocs material theme
Test Plan
Both mkdocs and material are well maintained repositories and have active communities. A test strategy is needed for the whole repo including mkdocs. Github actions would be able to provide some tests, pre-commit hooks are nice options, and some documentation around required formatting would help too.
Change Safety