docs: fill journeydoc tutorials (content + capture spec + screenshots) - #437
Merged
Conversation
Fills all 11 tutorial pages (8 user + 3 admin) with real prose — Goal, Prerequisites, numbered Steps with inline screenshot refs, Verification, Common-issues table, and Reference cross-links. Pattern follows the decidesk pilot (ConductionNL/decidiq#195). User track: - 01-first-launch: dashboard tour + navigation walk + Cases empty state - 02-my-work: tabs, completed toggle, Ter parafering panel - 03-view-case: list view, Cards/Table toggle, detail header, sidebar tabs - 04-advance-case: status transition flow + history audit trail - 05-record-decision: advice form + decision dialog + outcome on header - 06-track-deadlines: dashboard widgets, colour coding, drill-through - 07-handle-objection: bezwaar -> BAC -> beslissing op bezwaar - 08-inspection-checklist: LHS matrix, recommendation, override Admin track: - 01-configure-case-types: case-type wizard, statuses, deadlines, docs - 02-automatic-actions: trigger/condition/action rule engine - 03-admin-settings: Administration -> Procest settings page walk-through Capture spec (tests/e2e/docs-screenshots.spec.ts): - All 11 tests pass against a fresh dev environment (3.5 min runtime). - Uses shoot() / dismissOverlays() / go() helpers from hydra/templates/ journeydoc/, with go() normalising trailing slashes (procest's SPA shell 404s on '/apps/procest/' but works on '/apps/procest'). - Flow screenshots that need seed data (case detail, transition dialog, decision dialog, LHS matrix) fall back to empty-state list views; TODO comments mark which steps need real objects. - Admin settings page lives at /index.php/settings/admin/procest (NC core settings, not the in-app /settings route). Global-setup (tests/e2e/global-setup.ts): - Upgraded to the canonical template's safety checks: bundle-built guard (auto-runs npm run build on CI when js/ is empty), reachability check on /status.php, login-failure detection, login via #header selector instead of URL-based wait. package.json: adds @playwright/test ^1.49.0 + test:e2e / test:e2e:docs / test:e2e:install scripts. Docs build verified: 'npm run build' completes with [SUCCESS]; only the pre-existing /privacy/ /terms/ /iso/ footer-link warnings remain, no broken-markdown-image warnings. Effort: ~2.5 hours, matches the 1.5-3 hr decidesk pilot band.
Contributor
Quality Report — ConductionNL/procest @
|
| Check | PHP | Vue | Security | License | Tests |
|---|---|---|---|---|---|
| lint | ✅ | ||||
| phpcs | ✅ | ||||
| phpmd | ✅ | ||||
| psalm | ✅ | ||||
| phpstan | ✅ | ||||
| phpmetrics | ✅ | ||||
| eslint | ✅ | ||||
| stylelint | ✅ | ||||
| composer | ✅ | ✅ 100/100 | |||
| npm | ✅ | ✅ 420/420 | |||
| PHPUnit | ✅ | ||||
| Newman | ⏭️ | ||||
| Playwright | ❌ |
Coverage: 0% (0/81 statements)
Spec coverage: 7% (30 tests / 456 specs)
Quality workflow — 2026-05-13 06:06 UTC
Download the full PDF report from the workflow artifacts.
14 tasks
rubenvdlinde
added a commit
that referenced
this pull request
May 13, 2026
* chore(openspec): add docs-product-pages-conformance change artifacts Audit on 2026-05-13 (consolidated report at apps-extra/AUDIT-product- pages-2026-05-13.md) found procest's docs/ partially conformant to the canonical product-pages spec shipped at https://design-system.conduction.nl/preview/product-pages/. Tier-3 follow-ups tracked separately: #440 UseCases/ + Integrations/ content #441 Dutch translation pass #442 static/oas/procest.json OpenAPI spec Pre-flight: preset bump and tutorial content fills already landed upstream (#433, #437) — scope adjusted accordingly. * docs: align with canonical product-pages structure Structural changes: - docs/features/ -> docs/Features/ (canonical casing) - docs/tutorials/ -> docs/user-guide/ (canonical name) - 6 root MDs moved to docs/Technical/ (architecture, design-decisions, development-guide, zgw-spec, government-compliance, market-analysis) - docs/README.md -> docs/index.md with id/title/sidebar_position frontmatter - New docs/installation.md (prerequisites, app-store install, ZGW config, troubleshooting) - New docs/UseCases/ + docs/Integrations/ draft stubs (content in #440) - _category_.json for Features (pos 3), UseCases (pos 4), Integrations (pos 5), Technical (pos 6); user-guide label updated to "User Guide" Config changes: - redocusaurus preset added, static/oas/procest.json placeholder OAS shim, /api/ route; "API Documentation" navbar item - i18n.locales expanded to ['en', 'nl'] with localeConfigs for both - Internal links updated: ../../features/ -> ../../Features/ in user-guide/ Em-dash sweep (357 -> 0): - All ` — ` replaced with `: ` across 29 MD files (Features/, Technical/, user-guide/); YAML frontmatter descriptions with colons quoted - Gate verified: git grep -E '—' docs/ returns 0 Build: PASS (en + nl, redocusaurus 2.5.0, Docusaurus 3.9.2)
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
1 participant
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.
Fills all 11 tutorial pages (8 user + 3 admin) with real prose and ships the matching Playwright capture spec. Follows the decidesk pilot pattern from ConductionNL/decidiq#195.
Coverage
User track (8 stories)
01-first-launch— dashboard tour, navigation walk, Cases empty state02-my-work— tabs, Show completed toggle, Ter parafering panel03-view-case— list view, Cards/Table toggle, detail header, sidebar tabs04-advance-case— status transition flow + history audit trail05-record-decision— advice form, decision dialog, outcome on header06-track-deadlines— dashboard widgets, colour coding, drill-through07-handle-objection— bezwaar → BAC → beslissing op bezwaar08-inspection-checklist— LHS matrix, recommendation, overrideAdmin track (3 stories)
01-configure-case-types— case-type wizard, statuses, deadlines, doc checklist02-automatic-actions— trigger / condition / action rule engine03-admin-settings— Administration → Procest settings page walk-throughCapture spec
tests/e2e/docs-screenshots.spec.ts— all 11 tests pass against a fresh dev environment (3.5 min runtime, 55 PNGs).shoot()/dismissOverlays()/go()helpers from the canonicalhydra/templates/journeydoc/template.go()normalises trailing slashes — procest's SPA shell 404s on/apps/procest/but works on/apps/procest(worth noting; reported as a separate finding).TODOcomments mark which steps need real objects./index.php/settings/admin/procest(not the in-app/settings).Global-setup hardening
tests/e2e/global-setup.tsupgraded to the canonical template's safety checks:npm run buildon CI whenjs/is empty)/status.php/loginafter submit)#headerselector wait instead of URL-based wait (more reliable on slower CI rigs)package.json
Adds
@playwright/test ^1.49.0todevDependenciesplustest:e2e/test:e2e:docs/test:e2e:installscripts.Verification
npm run buildindocs/completes with[SUCCESS]; only pre-existing/privacy///terms///iso/footer-link warnings remain — no broken-markdown-image warnings.Effort: ~2.5 hours, matches the 1.5–3 hr decidesk pilot band.