Docs:
- Write new files and put them in the
/docs
folder, preferably in some sub folder. - file a PR to merge into the
main
branch
Images:
- screenshots should use a short-hand for the name of the page that they are meant to be displayed on
- logos, headers, etc should have identifying labels
To build after new changes:
- I need to download the repo after merging PRs
- unzip to my working directory
python -m mkdocs serve
to launch locally- check for errors on the terminal and resolve in the files
python -m mkdocs build
to compile the static site files- uplaod the
/docs
andmkdocs.yml
file to this repo and merge any changes - upload the
/site
folder to the main site repo into thedev
branch - File a PR to merge
dev
intomain
- Wait 5 minutes for the website to update