Skip to content

docs: fill journeydoc tutorials#72

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

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

Conversation

@rubenvdlinde
Copy link
Copy Markdown
Contributor

Fill all 11 journeydoc tutorial pages with real prose (8 user-track + 3 admin-track), wire the docs-capture spec end-to-end, and commit the 54 screenshots produced by a clean docs-capture run against the local dev container.

Pages filled

User track:

  • user/01-first-launch — open Scholiq, walk the nav, confirm OR wiring
  • user/02-create-course — Courses → Add Item dialog, save, open detail
  • user/03-enrol-students — individual + Bulk-enrol from cohort/CSV
  • user/04-assignments — publish brief, accept submissions, mark
  • user/05-attendance — mark a session, roll-up to learner profile
  • user/06-grading — grade entries → final grade + RS256 publish
  • user/07-issue-certificate — verifiable credential + public verifier
  • user/08-track-progress — Learner profile tabs

Admin track:

  • admin/01-school-structure — programmes + cohorts + timetables
  • admin/02-compliance-audit — signed audit-pack ZIP via Data exchange
  • admin/03-admin-settings — register import, AI features, signing key

Capture spec

tests/e2e/docs-screenshots.spec.ts rewritten to drive real flows via /apps/scholiq/{courses,enrolments,...} with shoot() / dismissOverlays() / go() / captureCreateDialog() helpers cloned from the decidesk pilot (decidesk#195). Empty-state fallbacks where seed data is not yet importable (OpenRegister register-import gap openregister#1487 — only 2 of 35 Scholiq schemas import on a fresh container today, so the index lists, create dialogs and the settings page are real but detail / populated views fall back to list/empty-state).

Verification

  • npx playwright test --project docs-capture — 11/11 pass.
  • 54 PNGs committed under docs/static/screenshots/tutorials/{user,admin}/.
  • cd docs && npm run build ends with [SUCCESS]. Only the expected /privacy/ / /terms/ / /iso/ footer warnings.

Pattern reference: decidesk#195 + ADR-030.

Filled in all 11 journeydoc tutorials with real prose (8 user-track +
3 admin-track), wired up the capture spec end-to-end, and committed
the 54 screenshots produced by a clean docs-capture run against the
local dev container.

Pages:
- user/01-first-launch — open Scholiq, walk the nav, confirm OR wiring
- user/02-create-course — Courses → Add Item dialog, save, open detail
- user/03-enrol-students — individual + Bulk-enrol from cohort/CSV
- user/04-assignments — publish brief, accept submissions, mark
- user/05-attendance — mark a session, roll-up to learner profile
- user/06-grading — grade entries → final grade + RS256 publish
- user/07-issue-certificate — verifiable credential + public verifier
- user/08-track-progress — Learner profile tabs (enrolments, grades,
  attendance, credentials, logs)
- admin/01-school-structure — programmes + cohorts + timetables
- admin/02-compliance-audit — signed audit-pack ZIP via Data exchange
- admin/03-admin-settings — register import, AI features, signing key

Capture spec: real flows via /apps/scholiq/{courses,enrolments,...}
with shoot() / dismissOverlays() / go() / captureCreateDialog()
helpers cloned from the decidesk pilot. Empty-state fallbacks where
seed data is not yet importable (OpenRegister register-import gap
openregister#1487).

Docs build verified locally: 11/11 capture tests pass, npm run build
in docs/ ends with [SUCCESS] (only the expected /privacy /terms /iso
footer warnings).
@rubenvdlinde rubenvdlinde merged commit 4e15f2d into development May 13, 2026
29 of 30 checks passed
@rubenvdlinde rubenvdlinde deleted the feature/journeydoc-fill branch May 13, 2026 05:49
@github-actions
Copy link
Copy Markdown
Contributor

Quality Report — ConductionNL/scholiq @ f6c740a

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

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