Merge branch 'main' into 2.3

Author: JackWilb

README.md

@@ -84,4 +84,8 @@ Note that this wil _only_ render when we have the right-hand sidebar in the mark
 
 
 
+## Testimonials
 
+Testimonials about papers that use revisit can be submitted via a form: https://forms.gle/nYqAoqESHdDtK2yH6 
+
+To update the website, copy the responses as a csv into `static/testimonials.csv' from [here](https://docs.google.com/spreadsheets/d/1ox3MUu6sLJlPZA_ULuawBroC0CicxcSkdGcItRTQwb4/edit?gid=1547627539#gid=1547627539). 

docs/analysis/data-export.md

@@ -159,7 +159,6 @@ To download screen recording from specific participants, select the participants
 ![Download screen recording video](./img/screen-recording-export-single.png)
 
 
-
 import StructuredLinks from '@site/src/components/StructuredLinks/StructuredLinks.tsx';
 
 <StructuredLinks

docs/analysis/participant-replay.md

@@ -1,15 +1,6 @@
 # Participant Replay
 
-import StructuredLinks from '@site/src/components/StructuredLinks/StructuredLinks.tsx';
 
-<StructuredLinks
-    demoLinks={[
-        {name: "Brush Interactions Demo", url: "https://revisit.dev/study/analysis/stats/example-brush-interactions"}
-    ]}
-    codeLinks={[
-        {name: "Brush Interactions Code", url: "https://github.com/revisit-studies/study/tree/main/public/example-brush-interactions"}
-    ]}
-/>
 
 The participant replay can be used for an overview of each participants study. 
 
@@ -33,3 +24,15 @@ You can specify time in different formats:
 - Hours: `&t=1h30m`  
 
 If the entered time exceeds the replay’s maximum length, it will automatically be replaced with the maximum available time in milliseconds.
+
+
+import StructuredLinks from '@site/src/components/StructuredLinks/StructuredLinks.tsx';
+
+<StructuredLinks
+    demoLinks={[
+        {name: "Brush Interactions Demo", url: "https://revisit.dev/study/analysis/stats/example-brush-interactions"}
+    ]}
+    codeLinks={[
+        {name: "Brush Interactions Code", url: "https://github.com/revisit-studies/study/tree/main/public/example-brush-interactions"}
+    ]}
+/>

docs/data-and-deployment/connecting-to-external-platform.md

@@ -1,13 +1,5 @@
 # Connecting with External Participant Platforms
 
-import StructuredLinks from '@site/src/components/StructuredLinks/StructuredLinks.tsx';
-
-<StructuredLinks
-    referenceLinks={[
-        {name: "Prolific", url: "https://prolific.com"},
-        {name: "SONA", url: "https://www.sona-systems.com"}
-    ]}
-/>
 
 ReVISit makes it easy to connect with participant management platforms such as Prolific, SONA Systems, and other custom services. Revisit can automatically collect participant IDs from study links, display those IDs inside the study, and redirect participants to a platform-specific return link after completion.
 
@@ -135,4 +127,16 @@ Just like with other platforms, you can display the SONA ID in the introduction
         }
     ]
 },
-```
+```
+
+
+
+
+import StructuredLinks from '@site/src/components/StructuredLinks/StructuredLinks.tsx';
+
+<StructuredLinks
+    referenceLinks={[
+        {name: "Prolific", url: "https://prolific.com"},
+        {name: "SONA", url: "https://www.sona-systems.com"}
+    ]}
+/>

docs/data-and-deployment/deploying-to-static-website.md

@@ -64,8 +64,8 @@ If you are using netlify as a secondary venue for anonymization purposes, you ca
 import StructuredLinks from '@site/src/components/StructuredLinks/StructuredLinks.tsx';
 
 <StructuredLinks
-referenceLinks={[
-{name: "GitHub Pages", url: "https://docs.github.com/en/pages/quickstart"},
-{name: "GitHub Custom Domain", url: "https://docs.github.com/en/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site"}
-]}
+  referenceLinks={[
+    {name: "GitHub Pages", url: "https://docs.github.com/en/pages/quickstart"},
+    {name: "GitHub Custom Domain", url: "https://docs.github.com/en/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site"}
+  ]}
 />

docs/data-and-deployment/lifecycle-of-revisit.md

@@ -1,12 +1,5 @@
 # The Lifecycle of a reVISit Study
 
-import StructuredLinks from '@site/src/components/StructuredLinks/StructuredLinks.tsx';
-
-<StructuredLinks
-referenceLinks={[
-{name: "Snapshots", url: "../../analysis/data-management/#snapshots"}
-]}
-/>
 
 A reVISit study will go through multiple stages over its lifetime. It'll first start as a local study that is iteratively refined until the study is fully built, it will then be deployed and tested, it will be send out to participants for data to be collected, and finally the study will be disseminated to reviewers.
 
@@ -55,3 +48,14 @@ When disseminating your study to reviewers and the wider public, you should:
 - Make the analytics interface publicly accessible
 
 If your are submitting to a venue that requires anonymization, such as ACM SIGCHI, consider creating a second deployment. If your primary deployment is on GitHub, consider adding a secondary one on [netlify](/docs/data-and-deployment/deploying-to-static-website/#deploying-using-netlify).
+
+
+
+
+import StructuredLinks from '@site/src/components/StructuredLinks/StructuredLinks.tsx';
+
+<StructuredLinks
+referenceLinks={[
+{name: "Snapshots", url: "../../analysis/data-management/#snapshots"}
+]}
+/>

docs/data-and-deployment/user-management.md

@@ -1,6 +1,5 @@
 # User Management In reVISit
 
-
 :::tip
 To use the user-management system that is built into reVISit, you must have a Firebase application set up. Please see [here](../firebase/setup) for how to set up a Firebase application. Additionally, you will need to enable the Google sign-in method for Authentication. You can find this section of the Firebase tutorial [here](../firebase/setup#authentication).
 :::
@@ -120,4 +119,4 @@ import StructuredLinks from '@site/src/components/StructuredLinks/StructuredLink
         {name: "Firebase Authentication", url: "https://firebase.google.com/products/auth"},
         {name: "Supabase Setup", url: "../supabase/setup"},
     ]}
-/>
+/>

docs/designing-studies/answers-trainings.md

@@ -1,20 +1,7 @@
 # Responses and Answers
 
-import StructuredLinks from '@site/src/components/StructuredLinks/StructuredLinks.tsx';
 
-<StructuredLinks
-    demoLinks={[
-      {name: "Training Demo", url: "https://revisit.dev/study/demo-training/"}
-    ]}
-    codeLinks={[
-      {name: "Training Code", url: "https://github.com/revisit-studies/study/tree/main/public/demo-training"}
-    ]}
-    referenceLinks={[
-        {name: "Base Response", url: "../../typedoc/interfaces/BaseResponse/"},
-        {name: "Reactive Response", url: "../../typedoc/interfaces/ReactiveResponse/"},
-        {name: "Answer", url: "../../typedoc/interfaces/Answer"}
-    ]}
-/>
+
 
 In reVISit, a component typically has a [response](../../typedoc/interfaces/BaseResponse/) that is recorded when a participant completes a task. Responses can be provided via form elements or via some other kind of payload through your custom component and a [ReactiveResponse](../../typedoc/interfaces/ReactiveResponse). 
 
@@ -79,3 +66,20 @@ The `provideFeedback` field adds a “Check Answer” button to the UI, which ca
 The above screenshot shows an example for when the response was incorrect. 
 
 Optionally, you can specify that trainings have to be successfully completed with the `allowFailedTraining` flag. You can specify the number of attempts with the `trainingAttempts` field. When failing is not allowed and the participant exceeds the number of failed attempts, **the study will terminate**. 
+
+
+import StructuredLinks from '@site/src/components/StructuredLinks/StructuredLinks.tsx';
+
+<StructuredLinks
+    demoLinks={[
+      {name: "Training Demo", url: "https://revisit.dev/study/demo-training/"}
+    ]}
+    codeLinks={[
+      {name: "Training Code", url: "https://github.com/revisit-studies/study/tree/main/public/demo-training"}
+    ]}
+    referenceLinks={[
+        {name: "Base Response", url: "../../typedoc/interfaces/BaseResponse/"},
+        {name: "Reactive Response", url: "../../typedoc/interfaces/ReactiveResponse/"},
+        {name: "Answer", url: "../../typedoc/interfaces/Answer"}
+    ]}
+/> 

docs/designing-studies/applying-style.md

@@ -1,21 +1,5 @@
 # Applying Styles
 
-import StructuredLinks from '@site/src/components/StructuredLinks/StructuredLinks.tsx';
-
-<StructuredLinks
-    demoLinks={[
-        {name: "Style Demo", url: "https://revisit.dev/study/demo-style"}
-    ]}
-    codeLinks={[
-        {name: "Style Demo Code", url: "https://github.com/revisit-studies/study/blob/main/public/demo-style"}
-    ]}
-    referenceLinks={[
-        {name: "UIConfig", url: "../../typedoc/interfaces/UIConfig"},
-        {name: "BaseIndividualComponent", url: "../../typedoc/interfaces/BaseIndividualComponent"},
-        {name: "BaseResponse", url: "../../typedoc/interfaces/BaseResponse"},
-        {name: "CSS Properties", url:"https://developer.mozilla.org/en-US/docs/Web/CSS/Properties"}
-    ]}
-/>
 
 ReVISit provides flexible styling capabilities to customize the appearance of your study components and responses. You can apply styles at three levels: **globally through UI configuration**, at the **component** level, and at the **response** level.
 
@@ -600,4 +584,23 @@ You can also make responses interactive using CSS. For example, you can change t
     box-shadow: 0 25px 80px #9abddc, 0 0 30px #9abddc, inset 0 0 20px rgba(154, 189, 220, 0.3);
   }
 }
-```
+```
+
+
+<!--   Importing Links -->
+import StructuredLinks from '@site/src/components/StructuredLinks/StructuredLinks.tsx';
+
+<StructuredLinks
+  demoLinks={[
+    {name: "Style Demo", url: "https://revisit.dev/study/demo-style"}
+  ]}
+  codeLinks={[
+    {name: "Style Demo Code", url: "https://github.com/revisit-studies/study/blob/main/public/demo-style"}
+  ]}
+  referenceLinks={[
+    {name: "UIConfig", url: "../../typedoc/interfaces/UIConfig"},
+    {name: "BaseIndividualComponent", url: "../../typedoc/interfaces/BaseIndividualComponent"},
+    {name: "BaseResponse", url: "../../typedoc/interfaces/BaseResponse"},
+    {name: "CSS Properties", url:"https://developer.mozilla.org/en-US/docs/Web/CSS/Properties"}
+  ]}
+/> 

docs/designing-studies/dynamic-blocks.md

@@ -1,20 +1,6 @@
 # Dynamic Blocks
 
-import StructuredLinks from '@site/src/components/StructuredLinks/StructuredLinks.tsx';
-
-<StructuredLinks
-    demoLinks={[
-      {name: "Dynamic Block Demo", url: "https://revisit.dev/study/demo-dynamic/"}
-    ]}
-    codeLinks={[
-      {name: "Dynamic Block Code", url: "https://github.com/revisit-studies/study/tree/main/public/demo-dynamic"}
-    ]}
-    referenceLinks={[
-        {name: "Dynamic Block", url:"../../typedoc/interfaces/DynamicBlock"}
-    ]}
-/>
 
-## Overview
 Some studies require knowledge of the participant's responses to previous questions to determine the next component that is shown. For example, if a participant answers a question incorrectly, they may be shown a simpler task next. Alternatively, if a participant answers a question correctly, they may be shown a more difficult task next. This is a common feature in adaptive testing, where the difficulty of the questions adapts to the participant's performance.
 
 In reVISit, this can be achieved using dynamic blocks. Dynamic blocks are blocks that use a function to calculate what the next component will be. This function is a typescript/javascript function that is defined in the `src/public/study-name/` folder and is referenced in the study configuration file like so:
@@ -96,3 +82,17 @@ export default function func({ answers } : JumpFunctionParameters<{name: string}
 ```
 
 In this example, the function checks how many questions the participant has answered so far. If the participant has answered 5 questions, the function returns `null`, which exits the dynamic block. Otherwise, the function returns the id of the next component to show, along with any parameters to pass to the component. In this case, the `reactComponent` component is shown, and the parameter `n` is passed to the component with the value of the number of questions the participant has answered so far.
+
+import StructuredLinks from '@site/src/components/StructuredLinks/StructuredLinks.tsx';
+
+<StructuredLinks
+    demoLinks={[
+      {name: "Dynamic Block Demo", url: "https://revisit.dev/study/demo-dynamic/"}
+    ]}
+    codeLinks={[
+      {name: "Dynamic Block Code", url: "https://github.com/revisit-studies/study/tree/main/public/demo-dynamic"}
+    ]}
+    referenceLinks={[
+        {name: "Dynamic Block", url:"../../typedoc/interfaces/DynamicBlock"}
+    ]}
+/>