Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Record package docs updates #119

Merged
merged 7 commits into from
Nov 18, 2024
Merged

Conversation

becky-gilbert
Copy link
Contributor

This PR makes some minor changes to the CHS Record package docs:

  • Adds separate sections for the start/stop recording plugins. This makes it easier to link to them from other places, and it will be useful when more parameters are added (e.g. upload time limit for stop recording).
  • Standardizes the sections:
    • adds "plugin"/"extension" to headers
    • subsections: 1) parameters, 2) example
  • Adds the 'admonitions' markdown extension.
  • Adds note about requiring a video config trial before any other recording.
  • Adds note about not using trial/session recording with other trials/extensions that use the webcam.
  • Fixes link to video-config section from templates docs.

Screenshots

Video consent:

Screenshot 2024-11-12 at 3 19 40 PM

Trial recording:

Screenshot 2024-11-12 at 3 19 32 PM

Session recording:

Screenshot 2024-11-12 at 3 19 17 PM

Copy link

changeset-bot bot commented Nov 12, 2024

🦋 Changeset detected

Latest commit: 33905a5

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@lookit/record Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@okaycj okaycj changed the base branch from main to develop November 18, 2024 18:05
@becky-gilbert becky-gilbert merged commit 1f7afa1 into develop Nov 18, 2024
2 checks passed
@becky-gilbert becky-gilbert deleted the add-start-stop-trial-docs branch November 18, 2024 22:01
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.

2 participants