dierickxsimon · ihosten · May 26, 2025 · May 26, 2025 · May 26, 2025 · May 29, 2025
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -17,3 +17,8 @@ repos:
     hooks:
       - id: flake8
         args: [--max-line-length=88, --extend-ignore=E203] # To make it compatible with black
+
+  - repo: https://github.com/srstevenson/nb-clean
+    rev: 4.0.1
+    hooks:
+      - id: nb-clean
diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md
@@ -34,7 +34,7 @@ To add a development dependency, run `uv add --dev <dependency>`.
 
 ## Testing
 
-To run tests, run either `uv run pytest`.
+To run tests, run `uv run pytest`.
 
 
 
@@ -43,7 +43,7 @@ To run tests, run either `uv run pytest`.
 - Never push to `main` directly
 - Create feature branches named `feature/{initials}_{feature_slug}` (e.g. `git checkout -b feature/sd_my_awesome_feature`)
 - Create a Pull Request to `main` when ready
-- Try not to merge your own PRs (we might enforce stricter rules later but for now let's keep it simple and fast)
+- Try not to merge your own PRs
 
 
 ## Pre-PR checklist

diff --git a/README.md b/README.md
@@ -4,10 +4,8 @@ A python package to analyse lactate based tresholds. Strongly inspired by [lacte
 
 docs can be found: https://dierickxsimon.github.io/lactopy/
 
-Still a work in progress...
 
-
-`lactopy` can be installed with pip:
+`lactopy` can be installed with `pip`:
 
 ```bash
 pip install lactopy

diff --git a/docs/assets/flexible-robust-diagram.png b/docs/assets/flexible-robust-diagram.png
diff --git a/docs/assets/flexible-robust-graph.png b/docs/assets/flexible-robust-graph.png
diff --git a/docs/css/custom_css.css b/docs/css/custom_css.css
@@ -0,0 +1,6 @@
+.center {
+  display: block;
+  margin-left: auto;
+  margin-right: auto;
+  text-align: center;
+}
diff --git a/docs/lactate_models/OBLA.md b/docs/lactate_models/OBLA.md
@@ -0,0 +1 @@
+:::lactopy.lactate_models.OBLA
diff --git a/docs/lactate_models/dmax.md b/docs/lactate_models/dmax.md
@@ -0,0 +1 @@
+:::lactopy.lactate_models.Dmax
diff --git a/docs/lactate_models/general/general.md b/docs/lactate_models/general/general.md
diff --git a/docs/lactate_models/second_threshold/dmax.md b/docs/lactate_models/second_threshold/dmax.md
diff --git a/docs/overview.md b/docs/overview.md
@@ -0,0 +1,6 @@
+# Overview
+
+In this overview we will give you a quick explanation of all the different models and how they can be used.
+
+![flexible-robust-diagram](assets/flexible-robust-diagram.png){.center}
+![flexible-robust-diagram](assets/flexible-robust-graph.png){.center}