Skip to content

docs: Add macOS screen recording permission requirement to record action docs#16

Open
promptless[bot] wants to merge 1 commit intomainfrom
promptless/add-macos-recording-permission-docs
Open

docs: Add macOS screen recording permission requirement to record action docs#16
promptless[bot] wants to merge 1 commit intomainfrom
promptless/add-macos-recording-permission-docs

Conversation

@promptless
Copy link
Contributor

@promptless promptless bot commented Mar 1, 2026

Open this suggestion in Promptless to view citations and reasoning process

Adds a note to the record action documentation explaining that macOS users need to grant Chrome screen recording permission in System Settings > Privacy & Security > Screen Recording for video recording to work. This addresses the improved error handling in PR #177 which provides clearer feedback when recording fails due to missing permissions.

Trigger Events

doc-detective/doc-detective PR #177: fix: recording on macOS

Promptless Research (1 GitHub PR)

Agent Response

I've reviewed PR #177 and created a documentation suggestion to address the macOS screen recording permission requirement.

Summary

PR #177 improves recording functionality on macOS by adding better error handling when screen recording fails. The key user-facing change is that when recording fails on macOS, Doc Detective now provides a clear error message explaining that Chrome needs screen recording permission.

Documentation Update

I created a suggestion that adds a note to the record action documentation explaining the macOS permission requirement:

Note: On macOS, Chrome needs screen recording permission. If recording fails, enable Chrome in System Settings (or System Preferences on older versions) > Privacy & Security > Screen Recording.

This note is placed alongside the existing Chrome-only note at the top of the action documentation, so users see all platform requirements upfront before diving into the examples.

The record-video.mdx tutorial already links to the record action page, so users following that tutorial will discover the macOS requirement when they click through to the reference documentation. This keeps the tutorial focused on the walkthrough while the action documentation serves as the canonical reference for platform requirements.


Tip: Request one-off documentation tasks in the Dashboard under New Task 🚀


*Note: Recording is currently only supported in visible Chrome browsers.*

*Note: On macOS, Chrome needs screen recording permission. If recording fails, enable Chrome in **System Settings** (or **System Preferences** on older versions) > **Privacy & Security** > **Screen Recording**.*
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: Based on the error handling added in src/core/tests/startRecording.ts which now provides a clear error message when recording fails on macOS due to missing screen recording permissions.
View source

@github-actions
Copy link

github-actions bot commented Mar 1, 2026

@promptless promptless bot marked this pull request as ready for review March 1, 2026 04:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants