Skip to content

docs(journeydoc): bootstrap capture-driven user documentation#423

Merged
rubenvdlinde merged 1 commit into
developmentfrom
feature/journeydoc-init
May 12, 2026
Merged

docs(journeydoc): bootstrap capture-driven user documentation#423
rubenvdlinde merged 1 commit into
developmentfrom
feature/journeydoc-init

Conversation

@rubenvdlinde
Copy link
Copy Markdown
Contributor

Bootstraps the journeydoc pattern (ADR-030) for Procest — capture-driven user documentation where a Playwright spec drives each user journey and refreshes every screenshot on demand.

Scaffold landed

  • docs/tutorials/_category_.json + docs/tutorials/{user,admin}/_category_.json — sidebar config for the two tracks
  • 11 numbered story skeletons (using tutorial-page.md.template; GOAL / PREREQS / STEPS / VERIFICATION / COMMON_ISSUES / REFERENCE left as {{TODO}} for the human author or /journeydoc-add-story):
    • User track (8): 01-first-launch, 02-my-work, 03-view-case, 04-advance-case, 05-record-decision, 06-track-deadlines, 07-handle-objection, 08-inspection-checklist
    • Admin track (3): 01-configure-case-types, 02-automatic-actions, 03-admin-settings
  • tests/e2e/docs-screenshots.spec.ts — capture spec with one test('UN <slug>', …) block per story (11 blocks), each a // TODO: see /journeydoc-add-story stub
  • playwright.config.ts — added the docs-capture project; the chromium regression project now testIgnores **/docs-screenshots.spec.ts
  • docs/docusaurus.config.jsmarkdown.hooks.onBrokenMarkdownImages: 'warn' so a fresh checkout that hasn't run the capture spec still builds
  • .github/workflows/documentation.yml — also build on development (was documentation-only)

Brown-field migrations applied

  • ✅ Moved docs/screenshots/docs/static/screenshots/ (8 PNGs) — Docusaurus only copies static/* into the build root, so the old location 404'd on deploy
  • ✅ Rewrote 15 relative ../screenshots/... / screenshots/... image refs to root-absolute /screenshots/... (8 in docs/features/*.md, 7 in docs/README.md)
  • ✅ Trimmed i18n.locales from ['en', 'nl'] to ['en'] — no translated markdown shipped under docs/i18n/nl/docusaurus-plugin-content-docs/current/ (only a stale current.json), which triggers SSR rendering errors on tutorial pages per ADR-030. The nl i18n/ JSON files are left in place for when a real translation backfill lands.
  • ⏭️ Docs domain — already on procest.conduction.nl across all three places (docs/static/CNAME, docusaurus.config.js url:, documentation.yml cname:). No change needed.

Notes / follow-ups

  • Story list cross-checked against openspec/specs/ (my-work, case-management, case-dashboard-view, status-transition-engine, advice/voorstel/roles-decisions, doorlooptijd-dashboard, bezwaar-lifecycle, inspection-checklists, case-types, automatic-actions, admin-settings all have specs).
  • Did not run npm run build on the docs site — the worktree is a fresh checkout without docs/node_modules; node -c docusaurus.config.js + JSON validation pass.
  • Next: fill the {{TODO}}s, run /journeydoc-instrument on capture-relevant Vue components for stable data-testids, then npx playwright test --project docs-capture to populate screenshots.

🤖 Generated with Claude Code

Adopts the journeydoc pattern (ADR-030) for Procest:

- docs/tutorials/{user,admin}/ with _category_.json sidebars and
  11 numbered story skeletons (8 user, 3 admin)
- tests/e2e/docs-screenshots.spec.ts capture spec with one test
  block per story
- playwright.config.ts: docs-capture project added; chromium
  regression project now ignores the capture spec
- docs/docusaurus.config.js: markdown.hooks.onBrokenMarkdownImages
  set to 'warn'
- .github/workflows/documentation.yml: also build on development

Brown-field migrations:
- moved docs/screenshots/ -> docs/static/screenshots/
- rewrote relative ../screenshots/ image refs to /screenshots/
  across docs/features/*.md and docs/README.md (8 + 7 refs)
- trimmed i18n.locales from ['en','nl'] to ['en'] (no translated
  markdown shipped under i18n/nl/.../current/)
- docs domain already on procest.conduction.nl (CNAME, docusaurus
  url, deploy workflow cname) — no change needed
@github-actions
Copy link
Copy Markdown
Contributor

Quality Report — ConductionNL/procest @ 22b4261

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

Spec coverage: 7% (32 tests / 456 specs)


Quality workflow — 2026-05-12 13:49 UTC

Download the full PDF report from the workflow artifacts.

@rubenvdlinde rubenvdlinde merged commit a00c997 into development May 12, 2026
34 of 42 checks passed
@rubenvdlinde rubenvdlinde deleted the feature/journeydoc-init branch May 12, 2026 21:21
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