add a page on CI to the docs

docs/ci.md

@@ -0,0 +1,16 @@
+# Continuous Integration
+
+Every commit to this repository is tested using continuous integration (CI).
+This ensures that the code is always working and that new changes do not break existing functionality.
+
+## GitHub Actions
+
+The CI is implemented using [GitHub Actions](https://github.com/features/actions).
+The example notebooks and the example scripts from [github.com/ZhaoWenzhao/QHCC](https://github.com/ZhaoWenzhao/QHCC) are
+run in the CI to ensure that they are working as expected, on all supported platforms.
+
+This is done for different Python versions (3.8, 3.9), operating systems (Linux, Windows, Mac) and dependency managers (pip and conda):
+
+![CI](ci.png)
+
+This website is also built and deployed as part of this CI process.

docs/models.md

@@ -3,14 +3,18 @@
 Example models and data are provided at [github.com/ZhaoWenzhao/QHCC](https://github.com/ZhaoWenzhao/QHCC).
 
 In order to run the provided example scripts, you will need to use Python 3.8 or 3.9, and install the required Python libraries.
+
+## pip & requirements.txt
 You can do this with pip, by first [downloading requirements.txt](requirements.txt) and then running:
 
 === "pip"
     ```bash
     pip install -r requirements.txt
     ```
 
-Or with conda or micromamba, by first [downloading environment.yml](environment.yml) and then running:
+## conda & environment.yml
+
+You could also use conda or micromamba, by first [downloading environment.yml](environment.yml) and then running:
 
 === "conda"
     ```bash
@@ -24,6 +28,8 @@ Or with conda or micromamba, by first [downloading environment.yml](environment.
     micromamba activate QHCC
     ```
 
+## direct pip/conda
+
 Alternatively you can install the required Python libraries directly:
 
 === "pip"

mkdocs.yml

@@ -21,3 +21,4 @@ nav:
   - Home: index.md
   - Data: data.md
   - Models: models.md
+  - Continuous Integration: ci.md