Skip to content

Commit 62a7673

Browse files
committed
Update tutorial content
1 parent 8242a37 commit 62a7673

4 files changed

Lines changed: 8 additions & 9 deletions

File tree

docs/tutorial/config.json.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,13 @@ Start the local server from the root of your template repository:
1414
yarn serve
1515
```
1616

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.
18+
19+
Let's add a tutorial study here.
1820

1921
```json title="public/global.json"
2022
{
21-
"$schema": "https://raw.githubusercontent.com/revisit-studies/study/v2.4.2/src/parser/GlobalConfigSchema.json",
23+
"$schema": "https://raw.githubusercontent.com/revisit-studies/study/v2.4.3/src/parser/GlobalConfigSchema.json",
2224
"configsList": ["tutorial"],
2325
"configs": {
2426
"tutorial": {
@@ -42,7 +44,7 @@ If you go into the tutorial study right now, you will be directed straight to th
4244

4345
![The tutorial study with the end page](./img/config.json/step2-1.png)
4446

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`.
4648

4749
```json title="public/tutorial/config.json"
4850
"components": {
@@ -67,8 +69,6 @@ Now add `welcome` to the sequence:
6769
}
6870
```
6971

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-
7272
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.
7373

7474

@@ -78,7 +78,6 @@ Refresh the local study or click "Next participant" to reload the Study Config a
7878
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.
7979
:::
8080

81-
8281
## Step 3: Add the consent component
8382

8483
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
9594
}
9695
```
9796

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.
9998

10099
Add `consent` after `welcome` in the sequence:
101100

@@ -606,7 +605,7 @@ Add a second React component trial that uses the same React file with different
606605
"reactExamplePenguins": {
607606
"type": "react-component",
608607
"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)?",
610609
"response": [
611610
{
612611
"id": "response",
5.67 KB
Loading
11.8 KB
Loading

docs/tutorial/replication-config.json.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Before editing the replication Study Config, open [`public/global.json`](https:/
1818

1919
```json title="public/global.json"
2020
{
21-
"$schema": "https://raw.githubusercontent.com/revisit-studies/study/v2.4.2/src/parser/GlobalConfigSchema.json",
21+
"$schema": "https://raw.githubusercontent.com/revisit-studies/study/v2.4.3/src/parser/GlobalConfigSchema.json",
2222
"configsList": ["tutorial", "replication"],
2323
"configs": {
2424
"tutorial": {

0 commit comments

Comments
 (0)