Skip to content
This repository was archived by the owner on May 29, 2026. It is now read-only.

Commit f858cf6

Browse files
rubenvdlinderubenvdlinde
authored
fix(docs): MDX-safe TODO placeholders in journeydoc tutorial skeletons (#43)
1 parent 6a593d0 commit f858cf6

11 files changed

Lines changed: 66 additions & 66 deletions

‎docs/tutorials/admin/01-rbac.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,26 +10,26 @@ Step-by-step guide to Manage who can build (RBAC)
1010

1111
## Goal
1212

13-
{{TODO: write the goal — what the reader will have accomplished by the end}}
13+
<!-- {{TODO: write the goal — what the reader will have accomplished by the end}} -->
1414

1515
## Prerequisites
1616

17-
{{TODO: list the prerequisites — what must be installed, enabled, or configured first}}
17+
<!-- {{TODO: list the prerequisites — what must be installed, enabled, or configured first}} -->
1818

1919
## Steps
2020

21-
{{TODO: write the numbered steps. Each step that needs a screenshot gets one shoot() call in tests/e2e/docs-screenshots.spec.ts and a corresponding image ref here, e.g. ![alt](/screenshots/tutorials/admin/1-<slug>-<step>.png)}}
21+
<!-- {{TODO: write the numbered steps. Each step that needs a screenshot gets one shoot() call in tests/e2e/docs-screenshots.spec.ts and a corresponding image ref here, e.g. ![alt](/screenshots/tutorials/admin/1-<slug>-<step>.png)}} -->
2222

2323
## Verification
2424

25-
{{TODO: how the reader confirms it worked}}
25+
<!-- {{TODO: how the reader confirms it worked}} -->
2626

2727
## Common issues
2828

2929
| Symptom | Fix |
3030
|---|---|
31-
| {{TODO: a likely failure}} | {{TODO: the fix}} |
31+
| <!-- {{TODO: a likely failure}} --> | <!-- {{TODO: the fix}} --> |
3232

3333
## Reference
3434

35-
{{TODO: link the relevant feature/spec reference pages}}
35+
<!-- {{TODO: link the relevant feature/spec reference pages}} -->

‎docs/tutorials/admin/02-template-catalogue.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,26 +10,26 @@ Step-by-step guide to Curate the template catalogue
1010

1111
## Goal
1212

13-
{{TODO: write the goal — what the reader will have accomplished by the end}}
13+
<!-- {{TODO: write the goal — what the reader will have accomplished by the end}} -->
1414

1515
## Prerequisites
1616

17-
{{TODO: list the prerequisites — what must be installed, enabled, or configured first}}
17+
<!-- {{TODO: list the prerequisites — what must be installed, enabled, or configured first}} -->
1818

1919
## Steps
2020

21-
{{TODO: write the numbered steps. Each step that needs a screenshot gets one shoot() call in tests/e2e/docs-screenshots.spec.ts and a corresponding image ref here, e.g. ![alt](/screenshots/tutorials/admin/2-<slug>-<step>.png)}}
21+
<!-- {{TODO: write the numbered steps. Each step that needs a screenshot gets one shoot() call in tests/e2e/docs-screenshots.spec.ts and a corresponding image ref here, e.g. ![alt](/screenshots/tutorials/admin/2-<slug>-<step>.png)}} -->
2222

2323
## Verification
2424

25-
{{TODO: how the reader confirms it worked}}
25+
<!-- {{TODO: how the reader confirms it worked}} -->
2626

2727
## Common issues
2828

2929
| Symptom | Fix |
3030
|---|---|
31-
| {{TODO: a likely failure}} | {{TODO: the fix}} |
31+
| <!-- {{TODO: a likely failure}} --> | <!-- {{TODO: the fix}} --> |
3232

3333
## Reference
3434

35-
{{TODO: link the relevant feature/spec reference pages}}
35+
<!-- {{TODO: link the relevant feature/spec reference pages}} -->

‎docs/tutorials/admin/03-admin-settings.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,26 +10,26 @@ Step-by-step guide to Manage OpenBuilt settings
1010

1111
## Goal
1212

13-
{{TODO: write the goal — what the reader will have accomplished by the end}}
13+
<!-- {{TODO: write the goal — what the reader will have accomplished by the end}} -->
1414

1515
## Prerequisites
1616

17-
{{TODO: list the prerequisites — what must be installed, enabled, or configured first}}
17+
<!-- {{TODO: list the prerequisites — what must be installed, enabled, or configured first}} -->
1818

1919
## Steps
2020

21-
{{TODO: write the numbered steps. Each step that needs a screenshot gets one shoot() call in tests/e2e/docs-screenshots.spec.ts and a corresponding image ref here, e.g. ![alt](/screenshots/tutorials/admin/3-<slug>-<step>.png)}}
21+
<!-- {{TODO: write the numbered steps. Each step that needs a screenshot gets one shoot() call in tests/e2e/docs-screenshots.spec.ts and a corresponding image ref here, e.g. ![alt](/screenshots/tutorials/admin/3-<slug>-<step>.png)}} -->
2222

2323
## Verification
2424

25-
{{TODO: how the reader confirms it worked}}
25+
<!-- {{TODO: how the reader confirms it worked}} -->
2626

2727
## Common issues
2828

2929
| Symptom | Fix |
3030
|---|---|
31-
| {{TODO: a likely failure}} | {{TODO: the fix}} |
31+
| <!-- {{TODO: a likely failure}} --> | <!-- {{TODO: the fix}} --> |
3232

3333
## Reference
3434

35-
{{TODO: link the relevant feature/spec reference pages}}
35+
<!-- {{TODO: link the relevant feature/spec reference pages}} -->

‎docs/tutorials/user/01-first-launch.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,26 +10,26 @@ Step-by-step guide to Open OpenBuilt for the first time
1010

1111
## Goal
1212

13-
{{TODO: write the goal — what the reader will have accomplished by the end}}
13+
<!-- {{TODO: write the goal — what the reader will have accomplished by the end}} -->
1414

1515
## Prerequisites
1616

17-
{{TODO: list the prerequisites — what must be installed, enabled, or configured first}}
17+
<!-- {{TODO: list the prerequisites — what must be installed, enabled, or configured first}} -->
1818

1919
## Steps
2020

21-
{{TODO: write the numbered steps. Each step that needs a screenshot gets one shoot() call in tests/e2e/docs-screenshots.spec.ts and a corresponding image ref here, e.g. ![alt](/screenshots/tutorials/user/1-<slug>-<step>.png)}}
21+
<!-- {{TODO: write the numbered steps. Each step that needs a screenshot gets one shoot() call in tests/e2e/docs-screenshots.spec.ts and a corresponding image ref here, e.g. ![alt](/screenshots/tutorials/user/1-<slug>-<step>.png)}} -->
2222

2323
## Verification
2424

25-
{{TODO: how the reader confirms it worked}}
25+
<!-- {{TODO: how the reader confirms it worked}} -->
2626

2727
## Common issues
2828

2929
| Symptom | Fix |
3030
|---|---|
31-
| {{TODO: a likely failure}} | {{TODO: the fix}} |
31+
| <!-- {{TODO: a likely failure}} --> | <!-- {{TODO: the fix}} --> |
3232

3333
## Reference
3434

35-
{{TODO: link the relevant feature/spec reference pages}}
35+
<!-- {{TODO: link the relevant feature/spec reference pages}} -->

‎docs/tutorials/user/02-create-from-template.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,26 +10,26 @@ Step-by-step guide to Create an application from a template
1010

1111
## Goal
1212

13-
{{TODO: write the goal — what the reader will have accomplished by the end}}
13+
<!-- {{TODO: write the goal — what the reader will have accomplished by the end}} -->
1414

1515
## Prerequisites
1616

17-
{{TODO: list the prerequisites — what must be installed, enabled, or configured first}}
17+
<!-- {{TODO: list the prerequisites — what must be installed, enabled, or configured first}} -->
1818

1919
## Steps
2020

21-
{{TODO: write the numbered steps. Each step that needs a screenshot gets one shoot() call in tests/e2e/docs-screenshots.spec.ts and a corresponding image ref here, e.g. ![alt](/screenshots/tutorials/user/2-<slug>-<step>.png)}}
21+
<!-- {{TODO: write the numbered steps. Each step that needs a screenshot gets one shoot() call in tests/e2e/docs-screenshots.spec.ts and a corresponding image ref here, e.g. ![alt](/screenshots/tutorials/user/2-<slug>-<step>.png)}} -->
2222

2323
## Verification
2424

25-
{{TODO: how the reader confirms it worked}}
25+
<!-- {{TODO: how the reader confirms it worked}} -->
2626

2727
## Common issues
2828

2929
| Symptom | Fix |
3030
|---|---|
31-
| {{TODO: a likely failure}} | {{TODO: the fix}} |
31+
| <!-- {{TODO: a likely failure}} --> | <!-- {{TODO: the fix}} --> |
3232

3333
## Reference
3434

35-
{{TODO: link the relevant feature/spec reference pages}}
35+
<!-- {{TODO: link the relevant feature/spec reference pages}} -->

‎docs/tutorials/user/03-design-schema.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,26 +10,26 @@ Step-by-step guide to Design a schema
1010

1111
## Goal
1212

13-
{{TODO: write the goal — what the reader will have accomplished by the end}}
13+
<!-- {{TODO: write the goal — what the reader will have accomplished by the end}} -->
1414

1515
## Prerequisites
1616

17-
{{TODO: list the prerequisites — what must be installed, enabled, or configured first}}
17+
<!-- {{TODO: list the prerequisites — what must be installed, enabled, or configured first}} -->
1818

1919
## Steps
2020

21-
{{TODO: write the numbered steps. Each step that needs a screenshot gets one shoot() call in tests/e2e/docs-screenshots.spec.ts and a corresponding image ref here, e.g. ![alt](/screenshots/tutorials/user/3-<slug>-<step>.png)}}
21+
<!-- {{TODO: write the numbered steps. Each step that needs a screenshot gets one shoot() call in tests/e2e/docs-screenshots.spec.ts and a corresponding image ref here, e.g. ![alt](/screenshots/tutorials/user/3-<slug>-<step>.png)}} -->
2222

2323
## Verification
2424

25-
{{TODO: how the reader confirms it worked}}
25+
<!-- {{TODO: how the reader confirms it worked}} -->
2626

2727
## Common issues
2828

2929
| Symptom | Fix |
3030
|---|---|
31-
| {{TODO: a likely failure}} | {{TODO: the fix}} |
31+
| <!-- {{TODO: a likely failure}} --> | <!-- {{TODO: the fix}} --> |
3232

3333
## Reference
3434

35-
{{TODO: link the relevant feature/spec reference pages}}
35+
<!-- {{TODO: link the relevant feature/spec reference pages}} -->

‎docs/tutorials/user/04-design-page.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,26 +10,26 @@ Step-by-step guide to Design a page
1010

1111
## Goal
1212

13-
{{TODO: write the goal — what the reader will have accomplished by the end}}
13+
<!-- {{TODO: write the goal — what the reader will have accomplished by the end}} -->
1414

1515
## Prerequisites
1616

17-
{{TODO: list the prerequisites — what must be installed, enabled, or configured first}}
17+
<!-- {{TODO: list the prerequisites — what must be installed, enabled, or configured first}} -->
1818

1919
## Steps
2020

21-
{{TODO: write the numbered steps. Each step that needs a screenshot gets one shoot() call in tests/e2e/docs-screenshots.spec.ts and a corresponding image ref here, e.g. ![alt](/screenshots/tutorials/user/4-<slug>-<step>.png)}}
21+
<!-- {{TODO: write the numbered steps. Each step that needs a screenshot gets one shoot() call in tests/e2e/docs-screenshots.spec.ts and a corresponding image ref here, e.g. ![alt](/screenshots/tutorials/user/4-<slug>-<step>.png)}} -->
2222

2323
## Verification
2424

25-
{{TODO: how the reader confirms it worked}}
25+
<!-- {{TODO: how the reader confirms it worked}} -->
2626

2727
## Common issues
2828

2929
| Symptom | Fix |
3030
|---|---|
31-
| {{TODO: a likely failure}} | {{TODO: the fix}} |
31+
| <!-- {{TODO: a likely failure}} --> | <!-- {{TODO: the fix}} --> |
3232

3333
## Reference
3434

35-
{{TODO: link the relevant feature/spec reference pages}}
35+
<!-- {{TODO: link the relevant feature/spec reference pages}} -->

‎docs/tutorials/user/05-connect-data.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,26 +10,26 @@ Step-by-step guide to Connect a register or connector
1010

1111
## Goal
1212

13-
{{TODO: write the goal — what the reader will have accomplished by the end}}
13+
<!-- {{TODO: write the goal — what the reader will have accomplished by the end}} -->
1414

1515
## Prerequisites
1616

17-
{{TODO: list the prerequisites — what must be installed, enabled, or configured first}}
17+
<!-- {{TODO: list the prerequisites — what must be installed, enabled, or configured first}} -->
1818

1919
## Steps
2020

21-
{{TODO: write the numbered steps. Each step that needs a screenshot gets one shoot() call in tests/e2e/docs-screenshots.spec.ts and a corresponding image ref here, e.g. ![alt](/screenshots/tutorials/user/5-<slug>-<step>.png)}}
21+
<!-- {{TODO: write the numbered steps. Each step that needs a screenshot gets one shoot() call in tests/e2e/docs-screenshots.spec.ts and a corresponding image ref here, e.g. ![alt](/screenshots/tutorials/user/5-<slug>-<step>.png)}} -->
2222

2323
## Verification
2424

25-
{{TODO: how the reader confirms it worked}}
25+
<!-- {{TODO: how the reader confirms it worked}} -->
2626

2727
## Common issues
2828

2929
| Symptom | Fix |
3030
|---|---|
31-
| {{TODO: a likely failure}} | {{TODO: the fix}} |
31+
| <!-- {{TODO: a likely failure}} --> | <!-- {{TODO: the fix}} --> |
3232

3333
## Reference
3434

35-
{{TODO: link the relevant feature/spec reference pages}}
35+
<!-- {{TODO: link the relevant feature/spec reference pages}} -->

‎docs/tutorials/user/06-preview-app.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,26 +10,26 @@ Step-by-step guide to Preview and run your app
1010

1111
## Goal
1212

13-
{{TODO: write the goal — what the reader will have accomplished by the end}}
13+
<!-- {{TODO: write the goal — what the reader will have accomplished by the end}} -->
1414

1515
## Prerequisites
1616

17-
{{TODO: list the prerequisites — what must be installed, enabled, or configured first}}
17+
<!-- {{TODO: list the prerequisites — what must be installed, enabled, or configured first}} -->
1818

1919
## Steps
2020

21-
{{TODO: write the numbered steps. Each step that needs a screenshot gets one shoot() call in tests/e2e/docs-screenshots.spec.ts and a corresponding image ref here, e.g. ![alt](/screenshots/tutorials/user/6-<slug>-<step>.png)}}
21+
<!-- {{TODO: write the numbered steps. Each step that needs a screenshot gets one shoot() call in tests/e2e/docs-screenshots.spec.ts and a corresponding image ref here, e.g. ![alt](/screenshots/tutorials/user/6-<slug>-<step>.png)}} -->
2222

2323
## Verification
2424

25-
{{TODO: how the reader confirms it worked}}
25+
<!-- {{TODO: how the reader confirms it worked}} -->
2626

2727
## Common issues
2828

2929
| Symptom | Fix |
3030
|---|---|
31-
| {{TODO: a likely failure}} | {{TODO: the fix}} |
31+
| <!-- {{TODO: a likely failure}} --> | <!-- {{TODO: the fix}} --> |
3232

3333
## Reference
3434

35-
{{TODO: link the relevant feature/spec reference pages}}
35+
<!-- {{TODO: link the relevant feature/spec reference pages}} -->

‎docs/tutorials/user/07-version-snapshots.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,26 +10,26 @@ Step-by-step guide to Snapshot and roll back a version
1010

1111
## Goal
1212

13-
{{TODO: write the goal — what the reader will have accomplished by the end}}
13+
<!-- {{TODO: write the goal — what the reader will have accomplished by the end}} -->
1414

1515
## Prerequisites
1616

17-
{{TODO: list the prerequisites — what must be installed, enabled, or configured first}}
17+
<!-- {{TODO: list the prerequisites — what must be installed, enabled, or configured first}} -->
1818

1919
## Steps
2020

21-
{{TODO: write the numbered steps. Each step that needs a screenshot gets one shoot() call in tests/e2e/docs-screenshots.spec.ts and a corresponding image ref here, e.g. ![alt](/screenshots/tutorials/user/7-<slug>-<step>.png)}}
21+
<!-- {{TODO: write the numbered steps. Each step that needs a screenshot gets one shoot() call in tests/e2e/docs-screenshots.spec.ts and a corresponding image ref here, e.g. ![alt](/screenshots/tutorials/user/7-<slug>-<step>.png)}} -->
2222

2323
## Verification
2424

25-
{{TODO: how the reader confirms it worked}}
25+
<!-- {{TODO: how the reader confirms it worked}} -->
2626

2727
## Common issues
2828

2929
| Symptom | Fix |
3030
|---|---|
31-
| {{TODO: a likely failure}} | {{TODO: the fix}} |
31+
| <!-- {{TODO: a likely failure}} --> | <!-- {{TODO: the fix}} --> |
3232

3333
## Reference
3434

35-
{{TODO: link the relevant feature/spec reference pages}}
35+
<!-- {{TODO: link the relevant feature/spec reference pages}} -->

0 commit comments

Comments
 (0)