Documentation updates from Promptless

Author: promptless[bot]

docs/get-started/tests/index.md

@@ -371,6 +371,65 @@ npx doc-detective --input https://doc-detective.com/sample.spec.json
 
 These tests run the same way as local tests, but Doc Detective fetches the test file from the specified URL and stores it in a temporary directory. The URL must be accessible to the machine running the tests.
 
+## Debug mode
+
+Doc Detective supports a debug mode that allows you to step through tests interactively and set breakpoints. This is particularly useful for debugging failing tests, understanding test execution flow, and developing new tests.
+
+### Configuration
+
+Configure debug mode using the `debug` property in your configuration:
+
+```json
+{
+  "input": "tests/",
+  "debug": false
+}
+```
+
+```json
+{
+  "input": "tests/",
+  "debug": true
+}
+```
+
+```json
+{
+  "input": "tests/",
+  "debug": "stepThrough"
+}
+```
+
+### Debug options
+
+- `false` (default): Disables all debugging
+- `true`: Allows pausing on breakpoints, waiting for user input before continuing
+- `"stepThrough"`: Pauses at every step, waiting for user input before continuing
+
+### Step-level breakpoints
+
+You can set breakpoints directly on individual steps using the `breakpoint` property:
+
+```json
+{
+  "tests": [
+    {
+      "steps": [
+        {
+          "description": "Normal step",
+          "wait": 1000
+        },
+        {
+          "description": "Debug this step",
+          "breakpoint": true,
+          "click": "#submit"
+        }
+      ]
+    }
+  ]
+}
+```
+
 ## Read the results
 
 Doc Detective outputs test results to a `testResults-<timestamp>.json` file in your `output` directory. You can also specify your output directory with the `--output` flag:

docs/references/schemas/config.md

@@ -7,7 +7,6 @@ Configuration options for Doc Detective operations.
 
 Field | Type | Description | Default
 :-- | :-- | :-- | :--
-$schema | string | Optional. JSON Schema for this object.<br/><br/>Accepted values: `https://raw.githubusercontent.com/doc-detective/common/refs/heads/main/dist/schemas/config_v3.schema.json` | 
 configId | string | Optional. Identifier for the configuration. | 
 configPath | string | ReadOnly. Path to the configuration file. | 
 input | one of:<br/>- string<br/>- array of string | Optional. Path(s) to test specifications and documentation source files. May be paths to specific files or to directories to scan for files. | `.`
@@ -19,13 +18,13 @@ origin | string | Optional. Default protocol and domain to use for relative URLs
 beforeAny | one of:<br/>- string<br/>- array of string | Optional. Path(s) to test specifications to perform before those specified by `input`. Useful for setting up testing environments. | 
 afterAll | one of:<br/>- string<br/>- array of string | Optional. Path(s) to test specifications to perform after those specified by `input`. Useful for cleaning up testing environments. | 
 detectSteps | boolean | Optional. Whether or not to detect steps in input files based on defined markup. | `true`
-allowUnsafeSteps | boolean | Optional. Whether or not to run potentially unsafe steps, such as those that might modify files or system state. | 
 logLevel | string | Optional. Amount of detail to output when performing an operation.<br/><br/>Accepted values: `silent`, `error`, `warning`, `info`, `debug` | `info`
+debug | one of:<br/>- boolean<br/>- string | Optional. Enable debugging mode. `true` allows pausing on breakpoints, waiting for user input before continuing. `"stepThrough"` pauses at every step, waiting for user input before continuing. `false` disables all debugging.<br/><br/>Accepted values: `false`, `true`, `"stepThrough"` | `false`
 runOn | array of object([context](/docs/references/schemas/context)) | Optional. Contexts to run the test in. Overrides contexts defined at the config and spec levels. | 
-fileTypes | array of one of: string, object([File type (custom)](/docs/references/schemas/file-type-custom)), object([File type (executable)](/docs/references/schemas/file-type-executable)) | Optional. Configuration for file types and their markup detection. | ``["markdown","asciidoc","html"]``
-integrations | object([Integrations options](/docs/references/schemas/integrations-options)) | Optional. Options for connecting to external services. | 
-telemetry | object([Telemetry options](/docs/references/schemas/telemetry-options)) | Optional. Options around sending telemetry for Doc Detective usage. | ``{"send":true}``
-environment | object([Environment details](/docs/references/schemas/environment-details)) | ReadOnly. Environment information for the system running Doc Detective. | 
+fileTypes | array of one of: string, object([File type (custom)](/docs/references/schemas/File%20type%20(custom))), object([File type (executable)](/docs/references/schemas/File%20type%20(executable))) | Optional. Configuration for file types and their markup detection. | ``["markdown","asciidoc","html"]``
+integrations | object([Integrations options](/docs/references/schemas/Integrations%20options)) | Optional. Options for connecting to external services. | 
+telemetry | object([Telemetry options](/docs/references/schemas/Telemetry%20options)) | Optional. Options around sending telemetry for Doc Detective usage. | ``{"send":true}``
+environment | object([Environment details](/docs/references/schemas/Environment%20details)) | ReadOnly. Environment information for the system running Doc Detective. | 
 
 ## Examples
 
@@ -118,3 +117,21 @@ environment | object([Environment details](/docs/references/schemas/environment-
   }
 }
 ```
+
+```json
+{
+  "debug": false
+}
+```
+
+```json
+{
+  "debug": true
+}
+```
+
+```json
+{
+  "debug": "stepThrough"
+}
+```