docs

fgcz · Aug 16, 2024 · e5e3cac · e5e3cac
1 parent f5a96b0
commit e5e3cac
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 2 deletions.
diff --git a/docs/contribute.md b/docs/contribute.md
@@ -1,4 +1,4 @@
-# Contribute
+# Contributing
 
 This page describes some information relevant for contributing to bfabricPy.
 

diff --git a/docs/good_to_know.md b/docs/good_to_know.md
@@ -2,6 +2,11 @@
 
 ## Updating workunits with many associated resources
 
+!!! note "Summary: Updating workunits and its associated resources"
+    1. Set workunit state to `"processing"`.
+    2. Update workunit and associated resources, as much as you need to.
+    3. Set workunit state to `"available"`.
+
 When updating large workunits, it's crucial to prevent state recomputation in B-Fabric by setting the workunit state to `"processing"` before making any changes.
 Failing to do so can lead to significant performance issues and complications, especially during iterative updates.
 

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -10,3 +10,7 @@ theme:
   features:
     - navigation.sections
     - navigation.instant
+markdown_extensions:
+  - admonition
+plugins:
+  - mkdocstrings
diff --git a/pyproject.toml b/pyproject.toml
@@ -44,7 +44,8 @@ dev = [
     "nox",
     "uv",
     "mkdocs",
-    "mkdocs-material"
+    "mkdocs-material",
+    "mkdocstrings[python]",
 ]
 
 [project.urls]