Update documentation for gh-page #4

rl-institut · Feb 20, 2023 · afb7df4 · afb7df4
1 parent de04ee7
commit afb7df4
Showing 1 changed file with 6 additions and 1 deletion.
diff --git a/docs/documentation/index.md b/docs/documentation/index.md
@@ -19,5 +19,10 @@
 `mkdocs build` build the documentation
 
 ### Publish
-Publish MkDocs project on github pages (requires permissions on repository) <br>
+Publish MkDocs project on **GitHub Pages** (requires permissions on repository) <br>
 `mkdocs gh-deploy` manually deploy the local docs files to github pages
+
+Deploy with **GitHub Actions** 
+The file `.github\workflows\gh-pages.yml` creates an automated GitHub workflow.
+It is configured that it is pushed to the branch `gh-page` and then deployed online.
+A commit on the `production` branch triggers the workflow.