Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added mkdocs site to the repo #448

Closed
wants to merge 1 commit into from

Conversation

coleyr
Copy link

@coleyr coleyr commented Apr 8, 2023

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

  • I have added tests to cover my changes
  • I have considered potential risks and mitigations for my changes

image

@nponeccop nponeccop mentioned this pull request Apr 10, 2023
1 task
@nponeccop
Copy link
Contributor

@coleyr There are conflicts again due to the merging of other PRs

@coleyr
Copy link
Author

coleyr commented Apr 12, 2023

Created a new PR utilizing way more documentation :)

@coleyr coleyr closed this Apr 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants