Skip to content

Commit c33976f

Browse files
committed
Sync docs file
1 parent 1826583 commit c33976f

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

docs/README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,7 @@ The following plugins for MkDocs are being used:
8080
- https://squidfunk.github.io/mkdocs-material/
8181
- https://github.com/lukasgeiter/mkdocs-awesome-pages-plugin
8282

83-
## Serving final site
84-
The final site that gets displayed is in the "gh-pages" branch. Both the 1.20.1 and 1.21.1 workflows push to this branch, and a dropdown will appear on the site.
85-
Be very careful running any kind of mike command locally (mike deploy, mike set-default etc) since these will make commits to gh-pages, which might update the live site.
83+
## Deployment
84+
The hosted documentation is found on the `gh-pages` branch of the repository. [Mike](https://github.com/jimporter/mike) is used to deploy both the 1.20.1 and 1.21.1 documentation on the same site through Github Actions.
85+
86+
When working on the docs locally, the plain `mkdocs` commands should be used to view the changes made to the version of the docs you are currently working on, like the previously mentioned `mkdocs serve`.

0 commit comments

Comments
 (0)