[ ] an initial readme (can be the first few paragraphs of the README.md for now)
[ ] an initial mkdocs.yml
[ ] a GitHub Actions to publish to the gh-pages branch. There are instructions on the MkDocs page: link. This would probably involve using a good docker container and perhaps fetching the MkDocs dependencies.
I've had previous success with the following python deps:
We created a
gh-pages
branch to this repository, and https://perfpod.github.io/memory-collector/ points to the README.md.In this ticket, we create
docs
directory in the repomkdocs.yml
gh-pages
branch. There are instructions on theMkDocs
page: link. This would probably involve using a good docker container and perhaps fetching the MkDocs dependencies.I've had previous success with the following python deps:
here is a reference
mkdocs.yml
: