Skip to content

docs: fill journeydoc tutorial prose - #129

Merged
rubenvdlinde merged 1 commit into
developmentfrom
feature/journeydoc-fill
May 13, 2026
Merged

docs: fill journeydoc tutorial prose#129
rubenvdlinde merged 1 commit into
developmentfrom
feature/journeydoc-fill

Conversation

@rubenvdlinde

Copy link
Copy Markdown
Contributor

Fills in the journeydoc tutorial prose for the 8 user-track and 3 admin-track pages under docs/tutorials/, and splices in the new shared journeydoc scaffold from hydra#272 so a future capture run is one command away.

Pilot pattern reference: ConductionNL/decidiq#195.

Note: Larping is not yet installed in the local dev container, so the live capture run (npm run test:e2e:docs) hasn't been executed against the new prose — screenshot ![]() refs in the markdown point at /screenshots/tutorials/{user,admin}/<slug>-NN.png and will resolve once the app is installed, seeded, and the capture spec is run. Markdown warns rather than errors on the missing images (onBrokenMarkdownImages: 'warn' is already set in the preset default).

What's filled

  • 8 user-track tutorials: first-launch, create-character, character-skills, manage-items, conditions, event-subscription, export-character-sheet, track-xp
  • 3 admin-track tutorials: configure-game-system, approve-players, admin-settings
  • Each page: Goal / Prerequisites / numbered Steps with inline screenshot refs / Verification / Common-issues table (incl. a row noting screenshots are pending) / Reference cross-links to feature docs and sibling tutorials

Scaffold splice (from hydra#272)

  • tests/e2e/global-setup.ts — one-time Nextcloud login → tests/e2e/.auth/admin.json storage state
  • playwright.config.tsglobalSetup + use.storageState on both projects (chromium regression + docs-capture)
  • package.json@playwright/test ^1.49.0 devDep + test:e2e, test:e2e:docs, test:e2e:install scripts
  • tests/e2e/docs-screenshots.spec.ts — rewritten with the new shoot() / dismissOverlays() / go() / captureCreateDialog() helpers; test bodies map each tutorial's numbered steps to navigation + screenshot calls (best-effort sketches, since the live run is pending)

Build verify

cd docs && npm ci --legacy-peer-deps && npm run build[SUCCESS]. Pre-existing footer-link warnings (/privacy/, /terms/, /iso/) are unrelated.

Follow-up once Larping is installed + seeded

NEXTCLOUD_URL=http://localhost:8080 npm run test:e2e:install
NEXTCLOUD_URL=http://localhost:8080 npm run test:e2e:docs

That writes the PNGs into docs/static/screenshots/tutorials/{user,admin}/ and the markdown image refs start resolving.

@rubenvdlinde
rubenvdlinde merged commit 9ed26a3 into development May 13, 2026
27 checks passed
@rubenvdlinde
rubenvdlinde deleted the feature/journeydoc-fill branch May 13, 2026 05:44
@github-actions

Copy link
Copy Markdown
Contributor

Quality Report — ConductionNL/larpingapp @ 485ba91

Check PHP Vue Security License Tests
lint
phpcs
phpmd
psalm
phpstan
phpmetrics
eslint
stylelint
composer ✅ 94/94
npm ✅ 376/376
PHPUnit
Newman ⏭️
Playwright ⏭️

Coverage: 0% (0/10 statements)


Quality workflow — 2026-05-13 05:46 UTC

Download the full PDF report from the workflow artifacts.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant