docs: Copy debug to exp config (#9120)

determined-ai · Apr 15, 2024 · 0b2eab0 · 0b2eab0
1 parent 3f70a46
commit 0b2eab0
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 3 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -13,9 +13,9 @@
 
    attributions
 
-#############################
- Determined AI Documentation
-#############################
+##########################
+ Determined Documentation
+##########################
 
 .. meta::
    :http-equiv=x-ua-compatible: IE=edge

diff --git a/docs/reference/deploy/agent-config-reference.rst b/docs/reference/deploy/agent-config-reference.rst
@@ -171,6 +171,8 @@ Docker container or without the need to enter a password.
 
 Deprecated. This field has been deprecated and will be ignored. Use ``resource_pool`` instead.
 
+.. _agent-config-ref-debug:
+
 ***********
  ``debug``
 ***********

diff --git a/docs/reference/experiment-config-reference.rst b/docs/reference/experiment-config-reference.rst
@@ -344,6 +344,15 @@ Example configuration:
 
 This setting can be defined as a default setting for the entire cluster.
 
+**********************************************
+ ``debug`` option in agent configuration file
+**********************************************
+
+The :ref:`debug <agent-config-ref-debug>` option in the agent configuration file enables more
+verbose logging for diagnostic purposes when set to ``true``.
+
+While debugging, the logger will display lines highlighted in blue for easy identification.
+
 *******************
  Validation Policy
 *******************