From 3bb98d532e29faf7c55952bfaea09e485a8e03fd Mon Sep 17 00:00:00 2001 From: "promptless[bot]" <179508745+promptless[bot]@users.noreply.github.com> Date: Sat, 7 Mar 2026 02:55:37 +0000 Subject: [PATCH] Fix bugs identified during documentation migration --- README.md | 2 +- fern/pages/docs/get-started/ci.mdx | 2 +- fern/pages/reference/schemas/capture-screenshot-detailed.md | 3 +-- fern/pages/reference/schemas/http-request-detailed.md | 3 +-- fern/pages/reference/schemas/run-shell-command-detailed.md | 3 +-- 5 files changed, 5 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 58b5af9..8faf735 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ git clone https://github.com/doc-detective/docs cd docs # Install dependencies -npm run setup +npm install # Start the development server npm run dev diff --git a/fern/pages/docs/get-started/ci.mdx b/fern/pages/docs/get-started/ci.mdx index 383bd7a..d159ce3 100644 --- a/fern/pages/docs/get-started/ci.mdx +++ b/fern/pages/docs/get-started/ci.mdx @@ -147,7 +147,7 @@ Example using outputs: On Ubuntu runners, the action only supports headless browser mode. Chrome and Firefox contexts automatically fall back to headless mode when necessary. -If your tests require non-headless mode (like video recording with `startRecording`), use macOS or Windows runners instead: +If your tests require non-headless mode (like video recording with `record`), use macOS or Windows runners instead: ```yaml jobs: diff --git a/fern/pages/reference/schemas/capture-screenshot-detailed.md b/fern/pages/reference/schemas/capture-screenshot-detailed.md index 3ad5ab0..0e76b63 100644 --- a/fern/pages/reference/schemas/capture-screenshot-detailed.md +++ b/fern/pages/reference/schemas/capture-screenshot-detailed.md @@ -13,8 +13,7 @@ Field | Type | Description | Default path | string | Optional. File path of the PNG file. Accepts absolute paths. If not specified, the file name is the ID of the step.

Pattern: `([A-Za-z0-9_-]*\.(png|PNG)$|\$[A-Za-z0-9_]+)` | directory | string | Optional. Directory of the PNG file. If the directory doesn't exist, creates the directory. | maxVariation | number | Optional. Allowed variation in percentage of pixels between the new screenshot and the existing screenshot at `path`. If the difference between the new screenshot and the existing screenshot is greater than `maxVariation`, the step fails. If a screenshot doesn't exist at `path`, this value is ignored.

Minimum: 0. Maximum: 1 | `0.05` -overwrite | string | Optional. If `true`, overwrites the existing screenshot at `path` if it exists. -If `aboveVariation`, overwrites the existing screenshot at `path` if the difference between the new screenshot and the existing screenshot is greater than `maxVariation`.

Accepted values: `true`, `false`, `aboveVariation` | `aboveVariation` +overwrite | string | Optional. If `true`, overwrites the existing screenshot at `path` if it exists.
If `aboveVariation`, overwrites the existing screenshot at `path` if the difference between the new screenshot and the existing screenshot is greater than `maxVariation`.

Accepted values: `true`, `false`, `aboveVariation` | `aboveVariation` crop | one of:
- string
- object([Crop by element (detailed)](/reference/schemas/crop-by-element-detailed)) | Optional. No description provided. | ## Examples diff --git a/fern/pages/reference/schemas/http-request-detailed.md b/fern/pages/reference/schemas/http-request-detailed.md index 61800fe..191a714 100644 --- a/fern/pages/reference/schemas/http-request-detailed.md +++ b/fern/pages/reference/schemas/http-request-detailed.md @@ -21,8 +21,7 @@ allowAdditionalFields | boolean | Optional. If `false`, the step fails when the path | string | Optional. File path to save the command's output, relative to `directory`. Specify a file extension that matches the expected response type, such as `.json` for JSON content or `.txt` for strings. | directory | string | Optional. Directory to save the command's output. If the directory doesn't exist, creates the directory. If not specified, the directory is your media directory. | maxVariation | number | Optional. Allowed variation in percentage of text different between the current output and previously saved output. If the difference between the current output and the previous output is greater than `maxVariation`, the step fails. If output doesn't exist at `path`, this value is ignored.

Minimum: 0. Maximum: 1 | `0` -overwrite | string | Optional. If `true`, overwrites the existing output at `path` if it exists. -If `aboveVariation`, overwrites the existing output at `path` if the difference between the new output and the existing output is greater than `maxVariation`.

Accepted values: `true`, `false`, `aboveVariation` | `aboveVariation` +overwrite | string | Optional. If `true`, overwrites the existing output at `path` if it exists.
If `aboveVariation`, overwrites the existing output at `path` if the difference between the new output and the existing output is greater than `maxVariation`.

Accepted values: `true`, `false`, `aboveVariation` | `aboveVariation` ## Examples diff --git a/fern/pages/reference/schemas/run-shell-command-detailed.md b/fern/pages/reference/schemas/run-shell-command-detailed.md index 96b9d97..4ba6929 100644 --- a/fern/pages/reference/schemas/run-shell-command-detailed.md +++ b/fern/pages/reference/schemas/run-shell-command-detailed.md @@ -19,8 +19,7 @@ stdio | string | Optional. Content expected in the command's stdout or stderr. I path | string | Optional. File path to save the command's output, relative to `directory`. | directory | string | Optional. Directory to save the command's output. If the directory doesn't exist, creates the directory. If not specified, the directory is your media directory. | maxVariation | number | Optional. Allowed variation in percentage of text different between the current output and previously saved output. If the difference between the current output and the previous output is greater than `maxVariation`, the step fails. If output doesn't exist at `path`, this value is ignored.

Minimum: 0. Maximum: 1 | `0` -overwrite | string | Optional. If `true`, overwrites the existing output at `path` if it exists. -If `aboveVariation`, overwrites the existing output at `path` if the difference between the new output and the existing output is greater than `maxVariation`.

Accepted values: `true`, `false`, `aboveVariation` | `aboveVariation` +overwrite | string | Optional. If `true`, overwrites the existing output at `path` if it exists.
If `aboveVariation`, overwrites the existing output at `path` if the difference between the new output and the existing output is greater than `maxVariation`.

Accepted values: `true`, `false`, `aboveVariation` | `aboveVariation` timeout | integer | Optional. Max time in milliseconds the command is allowed to run. If the command runs longer than this, the step fails. | `60000` ## Examples