Skip to content
This repository was archived by the owner on Mar 12, 2026. It is now read-only.
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ git clone https://github.com/doc-detective/docs
cd docs

# Install dependencies
npm run setup
npm install
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Citation: PR #185 comment by hawkeyexl noted this fix: "Fixed in 3fdfd56. Changed npm run setup to npm install." The setup script doesn't exist in docs/package.json.
View source


# Start the development server
npm run dev
Expand Down
2 changes: 1 addition & 1 deletion fern/pages/docs/get-started/ci.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Citation: PR #185 comment by hawkeyexl noted this fix: "Fixed in 3fdfd56. Updated startRecording to record." The action was renamed from startRecording to record.
View source


```yaml
jobs:
Expand Down
3 changes: 1 addition & 2 deletions fern/pages/reference/schemas/capture-screenshot-detailed.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.<br/><br/>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.<br/><br/>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`.<br/><br/>Accepted values: `true`, `false`, `aboveVariation` | `aboveVariation`
overwrite | string | Optional. If `true`, overwrites the existing screenshot at `path` if it exists.<br/>If `aboveVariation`, overwrites the existing screenshot at `path` if the difference between the new screenshot and the existing screenshot is greater than `maxVariation`.<br/><br/>Accepted values: `true`, `false`, `aboveVariation` | `aboveVariation`
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Citation: PR #185 comment noted the overwrite field description breaks the markdown table due to a newline splitting the row. Copilot suggested: "Keep the full description within the same table row (for example with <br/>)" and hawkeyexl confirmed: "Fixed in 3fdfd56."
View source

crop | one of:<br/>- string<br/>- object([Crop by element (detailed)](/reference/schemas/crop-by-element-detailed)) | Optional. No description provided. |

## Examples
Expand Down
3 changes: 1 addition & 2 deletions fern/pages/reference/schemas/http-request-detailed.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.<br/><br/>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`.<br/><br/>Accepted values: `true`, `false`, `aboveVariation` | `aboveVariation`
overwrite | string | Optional. If `true`, overwrites the existing output at `path` if it exists.<br/>If `aboveVariation`, overwrites the existing output at `path` if the difference between the new output and the existing output is greater than `maxVariation`.<br/><br/>Accepted values: `true`, `false`, `aboveVariation` | `aboveVariation`

## Examples

Expand Down
3 changes: 1 addition & 2 deletions fern/pages/reference/schemas/run-shell-command-detailed.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.<br/><br/>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`.<br/><br/>Accepted values: `true`, `false`, `aboveVariation` | `aboveVariation`
overwrite | string | Optional. If `true`, overwrites the existing output at `path` if it exists.<br/>If `aboveVariation`, overwrites the existing output at `path` if the difference between the new output and the existing output is greater than `maxVariation`.<br/><br/>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
Expand Down