docs: fill journeydoc tutorial prose - #190
Merged
Merged
Conversation
… screenshots pending install+seed)
Contributor
Quality Report — ConductionNL/planix @
|
| 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.
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 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.pngand 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 indocs/docusaurus.config.js).What's filled
docs/features/*.md— all referenced files exist) and sibling tutorialsdocs/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.jsonstorage state (NEW for planix)tests/e2e/docs-screenshots.spec.ts— capture-spec with the newshoot()/dismissOverlays()/go()/captureCreateDialog()helpers; test bodies map each tutorial's numbered steps to navigation + screenshot calls (best-effort sketches)tests/e2e/.gitignore— ignoresplaywright-report/,test-results/,.auth/playwright.config.ts—globalSetup+use.storageStateon bothchromiumanddocs-captureprojects (NEW for planix)package.json—@playwright/test ^1.49.0devDep +test:e2e,test:e2e:docs,test:e2e:installscriptsdocs/tutorials/_category_.json,docs/tutorials/user/_category_.json,docs/tutorials/admin/_category_.json— Docusaurus generated-index entriesBuild 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
That writes the PNGs into
docs/static/screenshots/tutorials/{user,admin}/and the markdown image refs start resolving.