stub Choosing Good Parameters page

Opentrons · Mar 18, 2024 · 87bc7c4 · 87bc7c4
1 parent 26d6756
commit 87bc7c4
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 4 deletions.
diff --git a/api/docs/v2/parameters/choosing.rst b/api/docs/v2/parameters/choosing.rst
@@ -0,0 +1,12 @@
+:og:description: Advice on choosing effective parameters in Opentrons Python protocols.
+
+************************
+Choosing Good Parameters
+************************
+
+The first decision you need to make when adding parameters to your protocol is "What should be parameterized?" Your goals in adding parameters should be the following:
+
+1. **Add flexibility.** Accommodate changes from run to run or from lab to lab.
+2. **Work efficiently.** Don't burden run setup with too many choices or confusing options.
+3. **Avoid errors.** Ensure that every combination of parameters produces an analyzable, runnable protocol.
+
diff --git a/api/docs/v2/parameters/defining.rst b/api/docs/v2/parameters/defining.rst
@@ -90,7 +90,3 @@ An example string enumeration::
         default="flex_1channel_50",
         description="What pipette to use during the protocol.",
     )
-
-
-What to Parameterize
-====================
diff --git a/api/docs/v2/runtime_parameters.rst b/api/docs/v2/runtime_parameters.rst
@@ -7,6 +7,7 @@ Runtime Parameters
 ******************
 
 .. toctree::
+    parameters/choosing
     parameters/defining
     parameters/using_values