Skip to content
This repository was archived by the owner on Aug 4, 2026. It is now read-only.

docs: fill journeydoc tutorials - #14

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

docs: fill journeydoc tutorials#14
rubenvdlinde merged 1 commit into
developmentfrom
feature/journeydoc-fill

Conversation

@rubenvdlinde

Copy link
Copy Markdown
Contributor

Summary

Completes the journeydoc (ADR-030) rollout for deskdesk — promotes the bootstrap skeletons to real, capture-driven tutorials.

What's in

  • 6 user-track tutorials under docs/tutorials/user/ (full prose, numbered steps with screenshot refs, verification, common-issues, references):
    • 01 first-launch — open DeskDesk, navigation tour, bookings list
    • 02 browse-desks — floor picker, zone filter, desk metadata
    • 03 book-a-slot — full day / AM / PM / custom slots + overlap rule
    • 04 recurring-booking — weekly recurrence + per-occurrence cancel
    • 05 calendar-sync — Nextcloud Calendar mirror, one-way contract
    • 06 desk-knowledge — wiki sidebar via OpenConnector + xWiki
  • 3 admin-track tutorials under docs/tutorials/admin/:
    • 01 floors-zones — model the building, zones, desk metadata
    • 02 knowledge-source — wire up OpenConnector → xWiki
    • 03 admin-settings — registers, calendar toggle, recurring toggle, slot definitions
  • playwright.config.ts — adds globalSetup + use.storageState (the bootstrap left them as a TODO)
  • tests/e2e/global-setup.ts — NC login → storage state (mirrors mydash / decidesk)
  • tests/e2e/docs-screenshots.spec.ts — upgraded from skeleton to real Playwright flows
  • 37 PNGs under docs/static/screenshots/tutorials/{user,admin}/ — capture run from a healthy dev container, the first-launch / browse-desks / floors shots show real seeded desks across floors (4 desks across the 2nd/3rd Amsterdam floors); admin-settings shows the version-info card

Notes

  • Pattern reference: decidesk#195 (pilot).
  • Docs build verified: npm run build in docs/[SUCCESS]. Remaining warnings are footer-link only (/privacy, /terms, /iso) handled by the brand preset.
  • The dev container also returned real-content shots for many of the user-track flows; the structural fallbacks in the spec keep the suite green when seed data is absent.

🤖 Generated with Claude Code

Completes the journeydoc (ADR-030) rollout for deskdesk:
- 6 user-track tutorials covering the booking flow
  (first-launch, browse-desks, book-a-slot, recurring-booking,
  calendar-sync, desk-knowledge) — promoted from skeletons to
  real prose with numbered steps + verification + common-issues
- 3 admin-track tutorials (floors-zones, knowledge-source,
  admin-settings)
- Adds globalSetup + storageState wiring to playwright.config.ts
  (the bootstrap config left auth as a TODO)
- docs-screenshots.spec.ts upgraded from skeleton to real
  Playwright flows — 37 PNGs under
  docs/static/screenshots/tutorials/{user,admin}/
- Captures show real DeskDesk content (4 seeded desks across
  floors, admin settings card); flow-detail shots refresh once
  more seed data or stable testids land.

Build: `npm run build` in docs/ -> [SUCCESS].
@rubenvdlinde
rubenvdlinde merged commit 8f5a79e into development May 13, 2026
18 of 29 checks passed
@rubenvdlinde
rubenvdlinde deleted the feature/journeydoc-fill branch May 13, 2026 06:05
@github-actions

Copy link
Copy Markdown
Contributor

Quality Report — ConductionNL/deskdesk @ a21bc30

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

Quality workflow — 2026-05-13 06:06 UTC

Download the full PDF report from the workflow artifacts.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant