docs(journeydoc): bootstrap capture-driven user documentation#423
Merged
Conversation
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
Contributor
Quality Report — ConductionNL/procest @
|
| 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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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 trackstutorial-page.md.template; GOAL / PREREQS / STEPS / VERIFICATION / COMMON_ISSUES / REFERENCE left as{{TODO}}for the human author or/journeydoc-add-story):01-first-launch,02-my-work,03-view-case,04-advance-case,05-record-decision,06-track-deadlines,07-handle-objection,08-inspection-checklist01-configure-case-types,02-automatic-actions,03-admin-settingstests/e2e/docs-screenshots.spec.ts— capture spec with onetest('UN <slug>', …)block per story (11 blocks), each a// TODO: see /journeydoc-add-storystubplaywright.config.ts— added thedocs-captureproject; thechromiumregression project nowtestIgnores**/docs-screenshots.spec.tsdocs/docusaurus.config.js—markdown.hooks.onBrokenMarkdownImages: 'warn'so a fresh checkout that hasn't run the capture spec still builds.github/workflows/documentation.yml— also build ondevelopment(wasdocumentation-only)Brown-field migrations applied
docs/screenshots/→docs/static/screenshots/(8 PNGs) — Docusaurus only copiesstatic/*into the build root, so the old location 404'd on deploy../screenshots/.../screenshots/...image refs to root-absolute/screenshots/...(8 indocs/features/*.md, 7 indocs/README.md)i18n.localesfrom['en', 'nl']to['en']— no translated markdown shipped underdocs/i18n/nl/docusaurus-plugin-content-docs/current/(only a stalecurrent.json), which triggers SSR rendering errors on tutorial pages per ADR-030. Thenli18n/JSON files are left in place for when a real translation backfill lands.procest.conduction.nlacross all three places (docs/static/CNAME,docusaurus.config.js url:,documentation.yml cname:). No change needed.Notes / follow-ups
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).npm run buildon the docs site — the worktree is a fresh checkout withoutdocs/node_modules;node -c docusaurus.config.js+ JSON validation pass.{{TODO}}s, run/journeydoc-instrumenton capture-relevant Vue components for stabledata-testids, thennpx playwright test --project docs-captureto populate screenshots.🤖 Generated with Claude Code