docs(journeydoc): bootstrap capture-driven user documentation - #190
Merged
Conversation
Bootstrap a Docusaurus documentation site under docs/ and the
journeydoc capture-driven docs scaffold (ADR-030) for Decidesk:
- Docusaurus site (docusaurus.config.js, package.json/lock, sidebars.js,
src/css + src/pages + src/components, static/img/logo.svg, intro.md),
adapted from the pipelinq/scholiq sites; English-only i18n per ADR-030,
onBrokenMarkdownImages: warn, editUrl -> tree/development/docs/.
- docs/static/CNAME -> decidesk.conduction.nl; .github/workflows/documentation.yml
switched to the shared reusable workflow with cname decidesk.conduction.nl
and push/PR triggers on development + documentation.
- tutorials/{user,admin}/ skeletons: 8 user stories + 3 admin stories
from the tutorial-page template (TODO bodies for the human author).
- tests/e2e/docs-screenshots.spec.ts capture-spec stub (one test block
per story) + a from-scratch playwright.config.ts with chromium and
docs-capture projects.
- screenshots output dir docs/static/screenshots/tutorials/{user,admin}/
(.gitkeep); .gitignore rules for docs/ build artifacts, i18n/nl, and
Playwright output.
Local docs build verified: npm ci --legacy-peer-deps && npm run build
succeeds.
rubenvdlinde
requested review from
Rem-Dam,
SudoThijn,
WilcoLouwerse,
bbrands02,
remko48 and
rjzondervan
as code owners
May 12, 2026 21:03
Contributor
Quality Report — ConductionNL/decidesk @
|
| Check | PHP | Vue | Security | License | Tests |
|---|---|---|---|---|---|
| lint | ✅ | ||||
| phpcs | ✅ | ||||
| phpmd | ✅ | ||||
| psalm | ✅ | ||||
| phpstan | ✅ | ||||
| phpmetrics | ✅ | ||||
| eslint | ✅ | ||||
| stylelint | ✅ | ||||
| composer | ✅ | ✅ 100/100 | |||
| npm | ✅ | ✅ 471/471 | |||
| PHPUnit | ✅ | ||||
| Newman | ✅ | ||||
| Playwright | ⏭️ |
Coverage: 0% (0/115 statements)
Quality workflow — 2026-05-12 21:13 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.
Summary
Bootstraps a Docusaurus documentation site under
docs/plus the journeydoc capture-driven docs scaffold (ADR-030) for Decidesk. Decidesk previously had no Docusaurus site — onlydocs/features/— so this is a green-field bootstrap using the pipelinq / scholiq docs sites as the working template, with the journeydoc scaffold layered on top.What landed
Docusaurus site (
docs/)docusaurus.config.js— adapted from pipelinq/scholiq:title/tagline/url: https://decidesk.conduction.nl/baseUrl: //organizationName: ConductionNL/projectName: decidesk, navbar + footer wired,editUrl→tree/development/docs/,i18n.locales: ['en'](ADR-030 — no translated markdown shipped yet),markdown.hooks.onBrokenMarkdownImages: 'warn'.package.json(namedecidesk-docs) +package-lock.json(@conduction/docusaurus-preset ^1.4.3, consistent with the lock — same combo as the build-verified scholiq#64),sidebars.js(autogenerated),src/css/custom.css(Conduction Cobalt palette),src/pages/index.js+src/pages/index.module.css,src/components/HomepageFeatures/,static/img/logo.svg(fromimg/app-store.svg),intro.md.docs/features/mcp-tools.mdleft in place — the autogenerated sidebar picks it up.Docs domain wiring
docs/static/CNAME→decidesk.conduction.nl.github/workflows/documentation.yml→ shared reusable workflowConductionNL/.github/.github/workflows/documentation.yml@mainwithcname: decidesk.conduction.nl, triggers on push/PR todevelopment+documentation(wascname: decidesk.app,documentationonly).Journeydoc scaffold
docs/tutorials/{,user/,admin/}_category_.json01-first-launch,02-schedule-meeting,03-add-motion,04-propose-amendment,05-run-vote,06-take-minutes,07-track-decisions,08-ai-companion— fromtutorial-page.md.template, frontmatter pre-filled, bodies are backtick-wrapped{{TODO: …}}for the human author //journeydoc-add-story.01-configure-workflow,02-manage-members,03-admin-settings.tests/e2e/docs-screenshots.spec.ts— capture-spec stub with one emptytest('UN <slug>', …)block per story (11 total), each pointing at/journeydoc-add-story.playwright.config.ts— created from scratch (decidesk had none):chromiumregression project (testIgnore: ['**/docs-screenshots.spec.ts']) +docs-captureproject (testMatch /docs-screenshots\.spec\.ts$/, 1280×800 viewport).docs/static/screenshots/tutorials/{user,admin}/.gitkeep.gitignore— added rules fordocs/{node_modules,build,.docusaurus,.cache-loader},docs/i18n/nl/, and Playwright output dirs.Build status
cd docs && npm ci --legacy-peer-deps && npm run build→ [SUCCESS] Generated static files in "build". The only build noise isonBrokenLinks: warnwarnings for the brand preset's footer links (/privacy/,/terms/,/iso/) — same as the sibling scholiq#64 / shillinq#71 bootstraps; those pages live on the parent conduction.nl site.Notes / review points
src/pages/index.js,HomepageFeatures) andintro.mdare first-draft and worth a content pass./journeydoc-add-story; adddata-testids via/journeydoc-instrumentbefore writing capture-spec bodies.🤖 Generated with Claude Code