Skip to content

Commit e8fa060

Browse files
rubenvdlinderubenvdlinde
authored
fix(docs): MDX-safe TODO placeholders in journeydoc tutorial skeletons (#432)
1 parent d0e0225 commit e8fa060

11 files changed

Lines changed: 66 additions & 66 deletions

‎docs/tutorials/admin/01-configure-case-types.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,26 +10,26 @@ Step-by-step guide to Configure case types and workflows
1010

1111
## Goal
1212

13-
{{TODO: write the goal}}
13+
<!-- {{TODO: write the goal}} -->
1414

1515
## Prerequisites
1616

17-
{{TODO: list prerequisites}}
17+
<!-- {{TODO: list prerequisites}} -->
1818

1919
## Steps
2020

21-
{{TODO: numbered steps, each with one inline screenshot — see /journeydoc-add-story}}
21+
<!-- {{TODO: numbered steps, each with one inline screenshot — see /journeydoc-add-story}} -->
2222

2323
## Verification
2424

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

2727
## Common issues
2828

2929
| Symptom | Fix |
3030
|---|---|
31-
{{TODO: rows}}
31+
<!-- {{TODO: rows}} -->
3232

3333
## Reference
3434

35-
{{TODO: cross-link into features/*.md}}
35+
<!-- {{TODO: cross-link into features/*.md}} -->

‎docs/tutorials/admin/02-automatic-actions.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,26 +10,26 @@ Step-by-step guide to Set up automatic actions
1010

1111
## Goal
1212

13-
{{TODO: write the goal}}
13+
<!-- {{TODO: write the goal}} -->
1414

1515
## Prerequisites
1616

17-
{{TODO: list prerequisites}}
17+
<!-- {{TODO: list prerequisites}} -->
1818

1919
## Steps
2020

21-
{{TODO: numbered steps, each with one inline screenshot — see /journeydoc-add-story}}
21+
<!-- {{TODO: numbered steps, each with one inline screenshot — see /journeydoc-add-story}} -->
2222

2323
## Verification
2424

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

2727
## Common issues
2828

2929
| Symptom | Fix |
3030
|---|---|
31-
{{TODO: rows}}
31+
<!-- {{TODO: rows}} -->
3232

3333
## Reference
3434

35-
{{TODO: cross-link into features/*.md}}
35+
<!-- {{TODO: cross-link into features/*.md}} -->

‎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 Procest settings
1010

1111
## Goal
1212

13-
{{TODO: write the goal}}
13+
<!-- {{TODO: write the goal}} -->
1414

1515
## Prerequisites
1616

17-
{{TODO: list prerequisites}}
17+
<!-- {{TODO: list prerequisites}} -->
1818

1919
## Steps
2020

21-
{{TODO: numbered steps, each with one inline screenshot — see /journeydoc-add-story}}
21+
<!-- {{TODO: numbered steps, each with one inline screenshot — see /journeydoc-add-story}} -->
2222

2323
## Verification
2424

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

2727
## Common issues
2828

2929
| Symptom | Fix |
3030
|---|---|
31-
{{TODO: rows}}
31+
<!-- {{TODO: rows}} -->
3232

3333
## Reference
3434

35-
{{TODO: cross-link into features/*.md}}
35+
<!-- {{TODO: cross-link into features/*.md}} -->

‎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 Procest for the first time
1010

1111
## Goal
1212

13-
{{TODO: write the goal}}
13+
<!-- {{TODO: write the goal}} -->
1414

1515
## Prerequisites
1616

17-
{{TODO: list prerequisites}}
17+
<!-- {{TODO: list prerequisites}} -->
1818

1919
## Steps
2020

21-
{{TODO: numbered steps, each with one inline screenshot — see /journeydoc-add-story}}
21+
<!-- {{TODO: numbered steps, each with one inline screenshot — see /journeydoc-add-story}} -->
2222

2323
## Verification
2424

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

2727
## Common issues
2828

2929
| Symptom | Fix |
3030
|---|---|
31-
{{TODO: rows}}
31+
<!-- {{TODO: rows}} -->
3232

3333
## Reference
3434

35-
{{TODO: cross-link into features/*.md}}
35+
<!-- {{TODO: cross-link into features/*.md}} -->

‎docs/tutorials/user/02-my-work.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,26 +10,26 @@ Step-by-step guide to Find your work in My Work
1010

1111
## Goal
1212

13-
{{TODO: write the goal}}
13+
<!-- {{TODO: write the goal}} -->
1414

1515
## Prerequisites
1616

17-
{{TODO: list prerequisites}}
17+
<!-- {{TODO: list prerequisites}} -->
1818

1919
## Steps
2020

21-
{{TODO: numbered steps, each with one inline screenshot — see /journeydoc-add-story}}
21+
<!-- {{TODO: numbered steps, each with one inline screenshot — see /journeydoc-add-story}} -->
2222

2323
## Verification
2424

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

2727
## Common issues
2828

2929
| Symptom | Fix |
3030
|---|---|
31-
{{TODO: rows}}
31+
<!-- {{TODO: rows}} -->
3232

3333
## Reference
3434

35-
{{TODO: cross-link into features/*.md}}
35+
<!-- {{TODO: cross-link into features/*.md}} -->

‎docs/tutorials/user/03-view-case.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 and read a case
1010

1111
## Goal
1212

13-
{{TODO: write the goal}}
13+
<!-- {{TODO: write the goal}} -->
1414

1515
## Prerequisites
1616

17-
{{TODO: list prerequisites}}
17+
<!-- {{TODO: list prerequisites}} -->
1818

1919
## Steps
2020

21-
{{TODO: numbered steps, each with one inline screenshot — see /journeydoc-add-story}}
21+
<!-- {{TODO: numbered steps, each with one inline screenshot — see /journeydoc-add-story}} -->
2222

2323
## Verification
2424

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

2727
## Common issues
2828

2929
| Symptom | Fix |
3030
|---|---|
31-
{{TODO: rows}}
31+
<!-- {{TODO: rows}} -->
3232

3333
## Reference
3434

35-
{{TODO: cross-link into features/*.md}}
35+
<!-- {{TODO: cross-link into features/*.md}} -->

‎docs/tutorials/user/04-advance-case.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,26 +10,26 @@ Step-by-step guide to Move a case through its workflow
1010

1111
## Goal
1212

13-
{{TODO: write the goal}}
13+
<!-- {{TODO: write the goal}} -->
1414

1515
## Prerequisites
1616

17-
{{TODO: list prerequisites}}
17+
<!-- {{TODO: list prerequisites}} -->
1818

1919
## Steps
2020

21-
{{TODO: numbered steps, each with one inline screenshot — see /journeydoc-add-story}}
21+
<!-- {{TODO: numbered steps, each with one inline screenshot — see /journeydoc-add-story}} -->
2222

2323
## Verification
2424

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

2727
## Common issues
2828

2929
| Symptom | Fix |
3030
|---|---|
31-
{{TODO: rows}}
31+
<!-- {{TODO: rows}} -->
3232

3333
## Reference
3434

35-
{{TODO: cross-link into features/*.md}}
35+
<!-- {{TODO: cross-link into features/*.md}} -->

‎docs/tutorials/user/05-record-decision.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,26 +10,26 @@ Step-by-step guide to Record advice or a decision on a case
1010

1111
## Goal
1212

13-
{{TODO: write the goal}}
13+
<!-- {{TODO: write the goal}} -->
1414

1515
## Prerequisites
1616

17-
{{TODO: list prerequisites}}
17+
<!-- {{TODO: list prerequisites}} -->
1818

1919
## Steps
2020

21-
{{TODO: numbered steps, each with one inline screenshot — see /journeydoc-add-story}}
21+
<!-- {{TODO: numbered steps, each with one inline screenshot — see /journeydoc-add-story}} -->
2222

2323
## Verification
2424

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

2727
## Common issues
2828

2929
| Symptom | Fix |
3030
|---|---|
31-
{{TODO: rows}}
31+
<!-- {{TODO: rows}} -->
3232

3333
## Reference
3434

35-
{{TODO: cross-link into features/*.md}}
35+
<!-- {{TODO: cross-link into features/*.md}} -->

‎docs/tutorials/user/06-track-deadlines.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,26 +10,26 @@ Step-by-step guide to Track deadlines and lead times on the dashboard
1010

1111
## Goal
1212

13-
{{TODO: write the goal}}
13+
<!-- {{TODO: write the goal}} -->
1414

1515
## Prerequisites
1616

17-
{{TODO: list prerequisites}}
17+
<!-- {{TODO: list prerequisites}} -->
1818

1919
## Steps
2020

21-
{{TODO: numbered steps, each with one inline screenshot — see /journeydoc-add-story}}
21+
<!-- {{TODO: numbered steps, each with one inline screenshot — see /journeydoc-add-story}} -->
2222

2323
## Verification
2424

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

2727
## Common issues
2828

2929
| Symptom | Fix |
3030
|---|---|
31-
{{TODO: rows}}
31+
<!-- {{TODO: rows}} -->
3232

3333
## Reference
3434

35-
{{TODO: cross-link into features/*.md}}
35+
<!-- {{TODO: cross-link into features/*.md}} -->

‎docs/tutorials/user/07-handle-objection.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,26 +10,26 @@ Step-by-step guide to Handle an objection (bezwaar)
1010

1111
## Goal
1212

13-
{{TODO: write the goal}}
13+
<!-- {{TODO: write the goal}} -->
1414

1515
## Prerequisites
1616

17-
{{TODO: list prerequisites}}
17+
<!-- {{TODO: list prerequisites}} -->
1818

1919
## Steps
2020

21-
{{TODO: numbered steps, each with one inline screenshot — see /journeydoc-add-story}}
21+
<!-- {{TODO: numbered steps, each with one inline screenshot — see /journeydoc-add-story}} -->
2222

2323
## Verification
2424

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

2727
## Common issues
2828

2929
| Symptom | Fix |
3030
|---|---|
31-
{{TODO: rows}}
31+
<!-- {{TODO: rows}} -->
3232

3333
## Reference
3434

35-
{{TODO: cross-link into features/*.md}}
35+
<!-- {{TODO: cross-link into features/*.md}} -->

0 commit comments

Comments
 (0)