update docs

m3g · Oct 4, 2024 · 8aa5c7f · 8aa5c7f
1 parent d8bcc6c
commit 8aa5c7f
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/docs/src/Coaraci.md b/docs/src/Coaraci.md
@@ -1,4 +1,8 @@
-# Cluster submission management
+# [Cluster submission management](@id Coaraci)
+
+!!! warning
+    This is an experimental feature. Breaking changes may occur without 
+    a breaking package release.
 
 The `Coaraci` module of `MolSimToolkit` manages the submission of multiple independent tasks in a single job of a cluster, where the job requested multiple nodes.
 For example, a job requests 20 nodes from a SLURM computer cluster, and the goal is to run independent simulations on each of the nodes.

diff --git a/docs/src/Experimental.md b/docs/src/Experimental.md
@@ -6,4 +6,5 @@ semantic version of the package is not compromised to the changes of these
 features. 
 
 - [Simulation reweighting](@ref simulation_reweighting)
+- [Cluster submission management](@ref Coaraci)
Original file line number	Diff line number	Diff line change
Expand Up		@@ -6,4 +6,5 @@ semantic version of the package is not compromised to the changes of these
		features.

		- [Simulation reweighting](@ref simulation_reweighting)
		- [Cluster submission management](@ref Coaraci)