feat(docs): Mokosh product quick-start for mokosh-server (PMS-662) #388

Merged

nrupard merged 1 commit from feat/PMS-662-mokosh-quickstart into main

2026-07-21 21:40:59 +02:00

nrupard commented

2026-07-21 21:37:06 +02:00

Owner

What

PMS-662 asks for a Mokosh product quick-start / onboarding guide. As with PMS-678, the public-facing docs live under Bunyip for now, so this is a bunyip per-application doc for mokosh-server, rendered full-page at /apps/mokosh-server/docs/quick-start (sort_order -1 so it is the entry point ahead of the deployment pages).

Content (high-level, code-grounded)

A tour grounded in the actual module set, not aspirational:

Run it -> the Docker Compose setup (links PMS-678's pages).
Sign in -> Bunyip SSO (super admins by domain; everyone else placed into their tenant).
Organization -> tenants. Clients -> contacts.
Do the work -> tickets, with time / mileage / projects / calendar / dispatch / notes / attachments.
Service levels -> SLA policies + targets honouring business hours and holiday calendars, tracked by a background sweep.
Settings -> tenant config.

portal and reports are the only 501 stubs, so they are intentionally not documented as working.

Verified / caveat

Validated on a throwaway postgres (page seeded, sort_order -1, sorts first, body intact). Grounded in the codebase (routes/modules). A live fresh-instance UI walkthrough was not run (the full stack can't be stood up here), so the exact click-path should be confirmed against a running instance to fully close AC#3.

Dependencies / follow-ups

Cross-links the PMS-678 pages (docker-compose, split-deployment, registry-login), so those links resolve once PR #387 (PMS-678) is also merged. Uses migration prefix ...030 vs PMS-678's ...020 - no collision.
"Reachable from onboarding" (AC#1): the page is reachable via the app's docs index / catalog link today; a direct link from the Mokosh onboarding flow would be a small follow-up in mokosh-www.

## What PMS-662 asks for a Mokosh product quick-start / onboarding guide. As with PMS-678, the public-facing docs live under Bunyip for now, so this is a **bunyip per-application doc for `mokosh-server`**, rendered full-page at `/apps/mokosh-server/docs/quick-start` (`sort_order -1` so it is the entry point ahead of the deployment pages). ## Content (high-level, code-grounded) A tour grounded in the actual module set, not aspirational: - **Run it** -> the Docker Compose setup (links PMS-678's pages). - **Sign in** -> Bunyip SSO (super admins by domain; everyone else placed into their tenant). - **Organization** -> tenants. **Clients** -> contacts. - **Do the work** -> tickets, with time / mileage / projects / calendar / dispatch / notes / attachments. - **Service levels** -> SLA policies + targets honouring business hours and holiday calendars, tracked by a background sweep. - **Settings** -> tenant config. `portal` and `reports` are the only 501 stubs, so they are intentionally not documented as working. ## Verified / caveat Validated on a throwaway postgres (page seeded, `sort_order -1`, sorts first, body intact). Grounded in the codebase (routes/modules). **A live fresh-instance UI walkthrough was not run** (the full stack can't be stood up here), so the exact click-path should be confirmed against a running instance to fully close AC#3. ## Dependencies / follow-ups - Cross-links the **PMS-678** pages (`docker-compose`, `split-deployment`, `registry-login`), so those links resolve once PR #387 (PMS-678) is also merged. Uses migration prefix `...030` vs PMS-678's `...020` - no collision. - "Reachable from onboarding" (AC#1): the page is reachable via the app's docs index / catalog link today; a direct link from the Mokosh onboarding flow would be a small follow-up in mokosh-www.

nrupard added 1 commit

2026-07-21 21:37:06 +02:00

feat(docs): seed a Mokosh product quick-start for mokosh-server (PMS-662)

E2E / Playwright against deployment (pull_request) Successful in 31s

Details

Check / fmt + clippy + build + tests (pull_request) Successful in 3m49s

Details

Create release / Create release from merged PR (pull_request) Has been skipped

Details

737b151d8e

PMS-662 asks for a Mokosh product quick-start / onboarding guide. Like PMS-678, the public-facing docs live under Bunyip for now, so this is a bunyip per-application doc for the mokosh-server app, rendered full-page at /apps/mokosh-server/docs/quick-start (sort_order -1 so it is the entry point ahead of the deployment pages).

A high-level tour grounded in the actual module set (not aspirational): sign in via Bunyip SSO (super admins by domain, everyone else placed into their tenant), set up the organization (tenants), add clients (contacts), do the work (tickets, with time / mileage / projects / calendar / dispatch / notes / attachments), service levels (SLA policies + targets honouring business hours and holiday calendars, tracked by a background sweep), and settings. portal and reports are the only 501 stubs, so they are intentionally not documented as working. It cross-links the PMS-678 setup pages for deployment detail.

Validated on a throwaway postgres (page seeded, sort_order -1, sorts first, body intact). Grounded in the codebase (routes/modules); a live fresh-instance UI walkthrough was not run here (I cannot stand up the full stack), so the exact click-path should be confirmed against a running instance.

#PMS-662

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

nrupard scheduled this pull request to auto merge when all checks succeed

2026-07-21 21:39:52 +02:00