Skip to content

docs: fill journeydoc tutorial prose - #190

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

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

Conversation

@rubenvdlinde

Copy link
Copy Markdown
Contributor

Bootstraps the journeydoc scaffold for Planix and fills in the tutorial prose for 8 user-track and 3 admin-track pages under docs/tutorials/. Planix didn't have the journeydoc scaffold yet — this PR drops the full directory structure plus the new hydra#272 capture-spec scaffold so a future capture run is one command away.

Pilot pattern reference: ConductionNL/decidiq#195.

Note: Planix is not yet installed in the local dev container, so the live capture run (npm run test:e2e:docs) hasn't been executed. 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 docs/docusaurus.config.js).

What's filled

  • 8 user-track tutorials: first-launch, create-project, work-with-boards, manage-tasks, manage-backlog, log-time, my-work-and-dashboard, link-procest
  • 3 admin-track tutorials: configure-default-columns, manage-labels, 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 (docs/features/*.md — all referenced files exist) and sibling tutorials
  • Grounded in the app's openspec, FEATURES.md, ARCHITECTURE.md, and the feature docs under docs/features/ (kanban-board, tasks, projects, time-tracking, dashboard, admin-settings, procest-integration)

Scaffold (new + from hydra#272)

  • tests/e2e/global-setup.ts — one-time Nextcloud login → tests/e2e/.auth/admin.json storage state (NEW for planix)
  • tests/e2e/docs-screenshots.spec.ts — capture-spec with the new shoot() / dismissOverlays() / go() / captureCreateDialog() helpers; test bodies map each tutorial's numbered steps to navigation + screenshot calls (best-effort sketches)
  • tests/e2e/.gitignore — ignores playwright-report/, test-results/, .auth/
  • playwright.config.tsglobalSetup + use.storageState on both chromium and docs-capture projects (NEW for planix)
  • package.json@playwright/test ^1.49.0 devDep + test:e2e, test:e2e:docs, test:e2e:install scripts
  • docs/tutorials/_category_.json, docs/tutorials/user/_category_.json, docs/tutorials/admin/_category_.json — Docusaurus generated-index entries

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 Planix 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 bad4fcc into development May 13, 2026
28 checks passed
@rubenvdlinde
rubenvdlinde deleted the feature/journeydoc-fill branch May 13, 2026 06:06
@github-actions

Copy link
Copy Markdown
Contributor

Quality Report — ConductionNL/planix @ 7679573

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

Coverage: 0% (0/3 statements)


Quality workflow — 2026-05-13 06:08 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