Skip to content

fix(docs): MDX-safe TODO placeholders in journeydoc tutorials #43

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rubenvdlinde merged 1 commit into from
May 12, 2026
Merged

fix(docs): MDX-safe TODO placeholders in journeydoc tutorials #43

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions docs/tutorials/admin/01-rbac.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,26 +10,26 @@ Step-by-step guide to Manage who can build (RBAC)

## Goal

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

## Prerequisites

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

## Steps

{{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)}}
<!-- {{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)}} -->

## Verification

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

## Common issues

| Symptom | Fix |
|---|---|
| {{TODO: a likely failure}} | {{TODO: the fix}} |
| <!-- {{TODO: a likely failure}} --> | <!-- {{TODO: the fix}} --> |

## Reference

{{TODO: link the relevant feature/spec reference pages}}
<!-- {{TODO: link the relevant feature/spec reference pages}} -->
12 changes: 6 additions & 6 deletions docs/tutorials/admin/02-template-catalogue.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,26 +10,26 @@ Step-by-step guide to Curate the template catalogue

## Goal

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

## Prerequisites

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

## Steps

{{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)}}
<!-- {{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)}} -->

## Verification

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

## Common issues

| Symptom | Fix |
|---|---|
| {{TODO: a likely failure}} | {{TODO: the fix}} |
| <!-- {{TODO: a likely failure}} --> | <!-- {{TODO: the fix}} --> |

## Reference

{{TODO: link the relevant feature/spec reference pages}}
<!-- {{TODO: link the relevant feature/spec reference pages}} -->
12 changes: 6 additions & 6 deletions docs/tutorials/admin/03-admin-settings.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,26 +10,26 @@ Step-by-step guide to Manage OpenBuilt settings

## Goal

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

## Prerequisites

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

## Steps

{{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)}}
<!-- {{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)}} -->

## Verification

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

## Common issues

| Symptom | Fix |
|---|---|
| {{TODO: a likely failure}} | {{TODO: the fix}} |
| <!-- {{TODO: a likely failure}} --> | <!-- {{TODO: the fix}} --> |

## Reference

{{TODO: link the relevant feature/spec reference pages}}
<!-- {{TODO: link the relevant feature/spec reference pages}} -->
12 changes: 6 additions & 6 deletions docs/tutorials/user/01-first-launch.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,26 +10,26 @@ Step-by-step guide to Open OpenBuilt for the first time

## Goal

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

## Prerequisites

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

## Steps

{{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)}}
<!-- {{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)}} -->

## Verification

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

## Common issues

| Symptom | Fix |
|---|---|
| {{TODO: a likely failure}} | {{TODO: the fix}} |
| <!-- {{TODO: a likely failure}} --> | <!-- {{TODO: the fix}} --> |

## Reference

{{TODO: link the relevant feature/spec reference pages}}
<!-- {{TODO: link the relevant feature/spec reference pages}} -->
12 changes: 6 additions & 6 deletions docs/tutorials/user/02-create-from-template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,26 +10,26 @@ Step-by-step guide to Create an application from a template

## Goal

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

## Prerequisites

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

## Steps

{{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)}}
<!-- {{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)}} -->

## Verification

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

## Common issues

| Symptom | Fix |
|---|---|
| {{TODO: a likely failure}} | {{TODO: the fix}} |
| <!-- {{TODO: a likely failure}} --> | <!-- {{TODO: the fix}} --> |

## Reference

{{TODO: link the relevant feature/spec reference pages}}
<!-- {{TODO: link the relevant feature/spec reference pages}} -->
12 changes: 6 additions & 6 deletions docs/tutorials/user/03-design-schema.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,26 +10,26 @@ Step-by-step guide to Design a schema

## Goal

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

## Prerequisites

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

## Steps

{{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)}}
<!-- {{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)}} -->

## Verification

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

## Common issues

| Symptom | Fix |
|---|---|
| {{TODO: a likely failure}} | {{TODO: the fix}} |
| <!-- {{TODO: a likely failure}} --> | <!-- {{TODO: the fix}} --> |

## Reference

{{TODO: link the relevant feature/spec reference pages}}
<!-- {{TODO: link the relevant feature/spec reference pages}} -->
12 changes: 6 additions & 6 deletions docs/tutorials/user/04-design-page.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,26 +10,26 @@ Step-by-step guide to Design a page

## Goal

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

## Prerequisites

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

## Steps

{{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)}}
<!-- {{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)}} -->

## Verification

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

## Common issues

| Symptom | Fix |
|---|---|
| {{TODO: a likely failure}} | {{TODO: the fix}} |
| <!-- {{TODO: a likely failure}} --> | <!-- {{TODO: the fix}} --> |

## Reference

{{TODO: link the relevant feature/spec reference pages}}
<!-- {{TODO: link the relevant feature/spec reference pages}} -->
12 changes: 6 additions & 6 deletions docs/tutorials/user/05-connect-data.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,26 +10,26 @@ Step-by-step guide to Connect a register or connector

## Goal

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

## Prerequisites

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

## Steps

{{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)}}
<!-- {{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)}} -->

## Verification

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

## Common issues

| Symptom | Fix |
|---|---|
| {{TODO: a likely failure}} | {{TODO: the fix}} |
| <!-- {{TODO: a likely failure}} --> | <!-- {{TODO: the fix}} --> |

## Reference

{{TODO: link the relevant feature/spec reference pages}}
<!-- {{TODO: link the relevant feature/spec reference pages}} -->
12 changes: 6 additions & 6 deletions docs/tutorials/user/06-preview-app.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,26 +10,26 @@ Step-by-step guide to Preview and run your app

## Goal

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

## Prerequisites

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

## Steps

{{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)}}
<!-- {{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)}} -->

## Verification

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

## Common issues

| Symptom | Fix |
|---|---|
| {{TODO: a likely failure}} | {{TODO: the fix}} |
| <!-- {{TODO: a likely failure}} --> | <!-- {{TODO: the fix}} --> |

## Reference

{{TODO: link the relevant feature/spec reference pages}}
<!-- {{TODO: link the relevant feature/spec reference pages}} -->
12 changes: 6 additions & 6 deletions docs/tutorials/user/07-version-snapshots.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,26 +10,26 @@ Step-by-step guide to Snapshot and roll back a version

## Goal

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

## Prerequisites

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

## Steps

{{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)}}
<!-- {{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)}} -->

## Verification

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

## Common issues

| Symptom | Fix |
|---|---|
| {{TODO: a likely failure}} | {{TODO: the fix}} |
| <!-- {{TODO: a likely failure}} --> | <!-- {{TODO: the fix}} --> |

## Reference

{{TODO: link the relevant feature/spec reference pages}}
<!-- {{TODO: link the relevant feature/spec reference pages}} -->
12 changes: 6 additions & 6 deletions docs/tutorials/user/08-export-app.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,26 +10,26 @@ Step-by-step guide to Export your app

## Goal

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

## Prerequisites

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

## Steps

{{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/8-<slug>-<step>.png)}}
<!-- {{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/8-<slug>-<step>.png)}} -->

## Verification

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

## Common issues

| Symptom | Fix |
|---|---|
| {{TODO: a likely failure}} | {{TODO: the fix}} |
| <!-- {{TODO: a likely failure}} --> | <!-- {{TODO: the fix}} --> |

## Reference

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