Skip to content

Commit 64ca0a0

Browse files
Copilothawkeyexl
andcommitted
Add troubleshooting guide and enhance action documentation
Co-authored-by: hawkeyexl <[email protected]>
1 parent f032bc4 commit 64ca0a0

File tree

4 files changed

+803
-0
lines changed

4 files changed

+803
-0
lines changed

docs/get-started/actions/httpRequest.mdx

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,13 @@ import JSONSchemaViewer from "@theme/JSONSchemaViewer";
1414

1515
The `httpRequest` action makes arbitrary HTTP calls, allowing you to interact with and validate APIs or other web services directly within your tests.
1616

17+
**Quick reference:**
18+
- **Purpose:** Test API endpoints and web services
19+
- **Common use:** API documentation validation, integration testing
20+
- **Supported methods:** GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS
21+
- **Validation:** Status codes, response headers, response body
22+
- **Variables:** Can capture response data for use in subsequent steps
23+
1724
You can specify a basic GET request using a string shorthand or use an object for more complex requests and validation:
1825

1926
- **String Shorthand:** Provide the full URL directly as the value for the `httpRequest` key. This performs a basic GET request to that URL.

docs/get-started/actions/runShell.mdx

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,13 @@ import JSONSchemaViewer from "@theme/JSONSchemaViewer";
1414

1515
The `runShell` action runs a shell command or script on the local machine and evaluates the results, extending Doc Detective's testing capabilities to anything you can script.
1616

17+
**Quick reference:**
18+
- **Purpose:** Execute shell commands, build scripts, run CLI tools
19+
- **Common use:** Build documentation, run tests, setup/cleanup, verify CLI outputs
20+
- **Shell:** Uses system default (cmd on Windows, bash/sh on Unix-like systems)
21+
- **Validation:** Exit codes, stdout/stderr output
22+
- **Variables:** Can capture command output for use in subsequent steps
23+
1724
`runShell` uses your device's native shell (`cmd` on Windows, `bash` or other default shell on macOS/Linux) to execute the command in the context of the current user.
1825

1926
You can specify the command directly as a string or use an object for more options:

0 commit comments

Comments
 (0)