docs

README.md

@@ -8,6 +8,8 @@ This package connects the [bfabric](https://fgcz-bfabric.uzh.ch/bfabric/) system
 The [bfabricShiny](https://github.com/cpanse/bfabricShiny) R package is an extension and provides code snippets and sample implementation for a seamless R shiny bfabric integration.
 For more advanced users the *bfabricPy* package also provides a powerful query interface on the command-line though using the provided scripts.
 
+You can find the up-to-date documentation at [https://fgcz.github.io/bfabricPy](https://fgcz.github.io/bfabricPy).
+
 ## CheatSheet
 
 ### Read

docs/contribute.md

@@ -17,3 +17,15 @@ With `nox` and `uv` installed, it is as simple as running `nox` in the project r
 ## Integration tests
 
 Note that integration tests have been moved to a separate repository. Please contact us if you are interested.
+
+## Documentation
+
+We currently do not have a versioning solution for the documentation, but we can add that later once it is more mature.
+
+```bash
+# To preview while you write it
+mkdocs serve
+
+# To publish after changes
+mkdocs gh-deploy
+```

pyproject.toml

@@ -42,7 +42,8 @@ dev = [
     "pytest-mock",
     "logot",
     "nox",
-    "uv"
+    "uv",
+    "mkdocs"
 ]
 
 [project.urls]