diff --git a/README.md b/README.md index 1d123c3..383e5fb 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,25 @@ To build the site locally, just run `mkdocs build` and the static site will be g ## Deployment -The site is automatically built and deployed via GitHub actions. +This site is using versioned documentation with [mike](https://github.com/jimporter/mike). + +> ⚠️ To deploy a new version, **merge all changes into `main` first** + +```shell +git switch main + +mike deploy -t "x.x (latest)" x.x latest + +mike serve + +# Check to ensure generated site is good to go + +git switch gh-pages + +git push + +git switch main +``` ## Development