Skip to content

Document screen and webcam recording - #269

Draft
JackWilb wants to merge 7 commits into
3.0from
codex/document-webcam-recording
Draft

JackWilb wants to merge 7 commits into
3.0from
codex/document-webcam-recording

Conversation

@JackWilb

Copy link
Copy Markdown
Contributor

Why

Document the screen and webcam recording support added to the ReVISit study application so study designers can configure capture, permission pages, analysis replay, and downloads.

Related implementation: revisit-studies/study#1159.

Architecture

The guide documents the existing configuration flags and permission components for screen-only, webcam-only, and combined recording. It explains that screen and webcam are stored as separate assets, while analysis and downloads expose them through the shared recording controls.

User-facing impact

  • Study designers can find setup examples for recordScreen, recordWebcam, and the two permission components.
  • The analysis replay layouts are documented: side by side, picture in picture, and webcam on top.
  • The data-export page explains bulk and task-level downloads for screen, webcam, or both.
  • The known limitation for recording requirements introduced only inside a dynamic block is documented, with the recommended configuration workaround.
  • Existing screen-recording pages were updated; no separate webcam documentation page was added.

Validation

  • corepack yarn build passed.
  • git diff --check passed.
  • corepack yarn checkLinks scanned 2,951 links and found one unrelated pre-existing 404 in the adoption page: https://buggenhoudt.pages.lisn.upsaclay.fr/revisit2/metroflow-test/.

Risk and rollout

Documentation-only change. No application behavior or versioned documentation was changed. Typedoc remains release-generated as documented in the repository instructions.

@github-actions

github-actions Bot commented Sep 10, 2026

Copy link
Copy Markdown

A preview of 294278b is uploaded and can be seen here:

https://revisit.dev/PR269

Changes may take a few minutes to propagate.

@JackWilb
JackWilb changed the base branch from main to 3.0 September 10, 2026 05:08
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.

3 participants