You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/tutorial/config.json.md
+7-8Lines changed: 7 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,11 +14,13 @@ Start the local server from the root of your template repository:
14
14
yarn serve
15
15
```
16
16
17
-
Before editing the tutorial Study Config, open [`public/global.json`](https://github.com/revisit-studies/template/blob/main/public/global.json). This file follows the [Global Config](../typedoc/interfaces/GlobalConfig.md) schema. The template already registers the tutorial config. You should see `tutorial` listed in both `configsList` and `configs`.
17
+
Before editing the tutorial Study Config, open [`public/global.json`](https://github.com/revisit-studies/template/blob/main/public/global.json). This file follows the [Global Config](../typedoc/interfaces/GlobalConfig.md) schema. The template should be empty for now.
@@ -42,7 +44,7 @@ If you go into the tutorial study right now, you will be directed straight to th
42
44
43
45

44
46
45
-
Inside the empty `components` object, add a basic [Markdown component](../typedoc/interfaces/MarkdownComponent.md) named `welcome`.
47
+
Next, open `public/tutorial/config.json`. Inside the empty `components` object, add a basic [Markdown component](../typedoc/interfaces/MarkdownComponent.md) named `welcome`.
46
48
47
49
```json title="public/tutorial/config.json"
48
50
"components": {
@@ -67,8 +69,6 @@ Now add `welcome` to the sequence:
67
69
}
68
70
```
69
71
70
-
Because this is a [fixed sequence](../designing-studies/sequences/study-sequences.md#simple-sequence), participants see the component names in this array from top to bottom.
71
-
72
72
Refresh the local study or click "Next participant" to reload the Study Config and start a fresh preview. You should now see the welcome page.
73
73
74
74
@@ -78,7 +78,6 @@ Refresh the local study or click "Next participant" to reload the Study Config a
78
78
A common mistake is to add the component but forget the sequence entry. If the component exists in `components` but is not listed in `sequence.components`, the component will not show up.
79
79
:::
80
80
81
-
82
81
## Step 3: Add the consent component
83
82
84
83
Add a comma after the `welcome` component, then add a second Markdown component named `consent`.
@@ -95,7 +94,7 @@ Add a comma after the `welcome` component, then add a second Markdown component
95
94
}
96
95
```
97
96
98
-
This component displays [`public/tutorial/assets/consent.md`](https://github.com/revisit-studies/template/blob/main/public/tutorial/assets/consent.md). The `nextButtonText` field changes the text on the next button, which is useful for consent pages because the button can say exactly what the participant is agreeing to.
97
+
This component displays [`public/tutorial/assets/consent.md`](https://github.com/revisit-studies/template/blob/main/public/tutorial/assets/consent.md). The `nextButtonText` field changes the text on the next button, which is useful for consent pages.
99
98
100
99
Add `consent` after `welcome` in the sequence:
101
100
@@ -606,7 +605,7 @@ Add a second React component trial that uses the same React file with different
606
605
"reactExamplePenguins": {
607
606
"type": "react-component",
608
607
"path": "tutorial/assets/ReactExample.tsx",
609
-
"instruction": "Consider only penguins with a body mass greater than 4000 g AND a flipper length greater than 200 mm. How many penguins match these conditions?",
608
+
"instruction": "How many Gentoo penguins weigh less than 4.5k grams (g)?",
0 commit comments