docs: Fix bugs identified during documentation migration#20
docs: Fix bugs identified during documentation migration#20promptless[bot] wants to merge 1 commit intomainfrom
Conversation
| 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: |
There was a problem hiding this comment.
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 |
There was a problem hiding this comment.
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` |
There was a problem hiding this comment.
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
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:
startRecordingtorecord(correct action name)npm run setuptonpm install(working setup command)overwritefield description was split across multiple linesTrigger Events
doc-detective/doc-detective PR #185: Migrate documentation and npmignore, upgrade fern version
Promptless Research (1 GitHub PR)
Agent Response
Tip: Configure how Promptless handles changelogs in Agent Settings 📋