From 018b92095179f5b619c6303d34599d51357edfba Mon Sep 17 00:00:00 2001
From: Becky Gilbert <beckyannegilbert@gmail.com>
Date: Tue, 12 Nov 2024 15:06:43 -0800
Subject: [PATCH] add admonitions extension and add notes about adding a video
 config trial, and when not to use trial/session recording

---
 mkdocs.yml                |  3 +++
 packages/record/README.md | 19 ++++++++++++++++++-
 2 files changed, 21 insertions(+), 1 deletion(-)

diff --git a/mkdocs.yml b/mkdocs.yml
index 43631ee..117e29a 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -35,3 +35,6 @@ plugins:
 
 extra:
   jsPsych: https://www.jspsych.org/v8/
+
+markdown_extensions:
+  - admonition
diff --git a/packages/record/README.md b/packages/record/README.md
index 1c830c1..2449573 100644
--- a/packages/record/README.md
+++ b/packages/record/README.md
@@ -67,7 +67,10 @@ Users will need to record themselves accepting the consent document for your
 study. This trial will allow the user to read the consent document and record a
 video accepting it.
 
-To create the video consent trial.
+!!! caution "Don't forget a video config trial!" You MUST have a video config
+trial in your experiment timeline before the video consent trial.
+
+To create the video consent trial:
 
 ```javascript
 const videoConsent = { type: chsRecord.VideoConsentPlugin, ...parameters };
@@ -335,6 +338,10 @@ that allows you to add video recording to the trial. The trial will start once
 the video recording has been set up, and the video recording will finish as soon
 as the trial has ended.
 
+!!! important "When to use trial recording" Trial recording should NOT occur
+simultaneously with session recording, or with any plugins that already use the
+webcam (e.g. video config, video consent).
+
 To use the CHS trial recording extension, you need to:
 
 1. Add it to the experiment settings, which is an optional object passed to
@@ -342,6 +349,9 @@ To use the CHS trial recording extension, you need to:
 2. Add it to the `extensions` parameter for any trial(s) that you want to be
    recorded.
 
+!!! caution "Don't forget a video config trial!" You MUST have a video config
+trial in your experiment timeline before doing any trial recording.
+
 ### Parameters
 
 This extension does not accept any parameters.
@@ -380,10 +390,17 @@ You might prefer to record across multiple trials in a study session. This can
 be done by using trials created with the start and stop recording plugins. This
 gives a bit of flexibility over which of the study trials are recorded.
 
+!!! important "When to use session recording" Sesssion recording should NOT
+occur simultaneously with trial recording, or with any plugins that already use
+the webcam (e.g. video config, video consent).
+
 To record a set of trials, add a 'start' trial in your jsPsych experiment
 timeline right before you'd like to start recording, and add a 'stop' trial at
 the point in your timeline when you'd like to stop recording.
 
+!!! caution "Don't forget a video config trial!" You MUST have a video config
+trial in your experiment timeline before doing any session recording.
+
 ### Start Recording Plugin
 
 The plugin to start session recording is called `chsRecord.StartRecordPlugin`.