Skip to content
This repository was archived by the owner on Mar 12, 2026. It is now read-only.

docs: Fix bugs identified during documentation migration#20

Closed
promptless[bot] wants to merge 1 commit intomainfrom
promptless/fix-bugs-from-migration
Closed

docs: Fix bugs identified during documentation migration#20
promptless[bot] wants to merge 1 commit intomainfrom
promptless/fix-bugs-from-migration

Conversation

@promptless
Copy link
Contributor

@promptless promptless bot commented Mar 7, 2026

Open this suggestion in Promptless to view citations and reasoning process

Applies bug fixes that were discovered and fixed during PR #185's documentation migration. These fixes were applied in the target repository but not backported to this source repo:

  • ci.mdx: Changed startRecording to record (correct action name)
  • README.md: Changed npm run setup to npm install (working setup command)
  • Schema reference pages: Fixed broken markdown table formatting where the overwrite field description was split across multiple lines

Trigger Events

doc-detective/doc-detective PR #185: Migrate documentation and npmignore, upgrade fern version

Promptless Research (1 GitHub PR)

Agent Response

I've completed processing PR #185. Here's a summary of what was done:

Summary

PR #185 migrated documentation from this repository to doc-detective/doc-detective/docs/. During that migration, several bugs were discovered and fixed in the target repository. I've backported those bug fixes to this source repository.

Changes Made

Created 1 suggestion with the following fixes:

File Fix
fern/pages/docs/get-started/ci.mdx Changed startRecording to record (correct action name)
README.md Changed npm run setup to npm install (the setup script doesn't exist)
fern/pages/reference/schemas/capture-screenshot-detailed.md Fixed broken markdown table (joined multi-line overwrite description)
fern/pages/reference/schemas/http-request-detailed.md Fixed broken markdown table (joined multi-line overwrite description)
fern/pages/reference/schemas/run-shell-command-detailed.md Fixed broken markdown table (joined multi-line overwrite description)

All fixes are based on issues identified and resolved in PR #185's review comments, ensuring this source repository stays in sync with the improvements made during the migration.


Tip: Configure how Promptless handles changelogs in Agent Settings 📋

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
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


# Install dependencies
npm run setup
npm install
Copy link
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

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
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

@github-actions
Copy link

github-actions bot commented Mar 7, 2026

@promptless promptless bot closed this Mar 12, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants