Updated docs.

This commit is contained in:
Pen Anderson 2026-03-05 09:51:40 -06:00
parent 2b409c65c1
commit 87da9cf97f
2 changed files with 18 additions and 9 deletions

View file

@ -16,7 +16,7 @@ After logging in, create accounts for your team under **Users**. Each user gets
| **ticketing** | Participants, Tickets, Import | Manage participants and tickets, run CSV imports |
| **staffing** | Dashboard, Schedule, Volunteers, Departments | Manage volunteers, departments, and shifts across all departments. No user management or settings |
| **colead** | Dashboard, Schedule, Volunteers | Manage volunteers and shifts within their assigned department(s) only |
| **gatekeeper** | Full-screen Gate UI | Check in ticket holders (search + QR scan). No access to other pages |
| **gatekeeper** | Full-screen Gate Kiosk | Check in ticket holders (search + QR scan). No access to other pages |
Coleads are scoped to one or more departments. When creating a colead user, assign their department(s).
@ -95,7 +95,15 @@ Under **Volunteers**, you can:
- Create volunteers manually (name, email, department)
- Assign volunteers to departments
- Mark volunteers as co-leads
- Check in volunteers
- Mark volunteers as ready (briefed at the volunteer station)
### Volunteer statuses
| Status | Meaning |
|--------|---------|
| **Unconfirmed** | Signed up but hasn't confirmed their email |
| **Confirmed** | Email confirmed, not yet briefed |
| **Ready** | Briefed at the volunteer station, has what they need to report for shifts |
Volunteers are separate from participants. A person can be both a ticket holder and a volunteer. When a volunteer signs up via the public form, they are automatically linked to their participant record by email.
@ -117,7 +125,7 @@ Shifts can be reordered within a department to reflect priority or sequence usin
## Volunteer Kiosk
The kiosk lets volunteers self-select shifts without logging in.
The Volunteer Kiosk is the public-facing flow for volunteers: signup, email confirmation, and shift self-scheduling. The shift scheduling page lets volunteers self-select shifts without logging in.
### Setup
@ -145,15 +153,16 @@ No login is required. The kiosk code authenticates the request.
Kiosk codes use the character set `A-Z, 2-9` (excluding 0/O, 1/I/L to avoid ambiguity when reading aloud or on printed badges).
## Gate Check-In
## Gate Kiosk
Users with the **gatekeeper** role see a dedicated full-screen UI:
Users with the **gatekeeper** role see a dedicated full-screen Gate Kiosk:
- **QR scanner** — uses the device camera via the BarcodeDetector API. Scanned codes populate the search field.
- **Search** — type a name to filter tickets in real-time (searches local IndexedDB, works offline).
- **Volunteer dual check-in** — if a ticket holder is also a volunteer, the gate UI shows their volunteer status and offers to check in both simultaneously.
- **Recent check-ins** — the last 10 check-ins are shown for quick reference.
Admins and ticketing leads can also check in tickets directly from the **Participants** page by expanding a participant's tickets.
Gate devices should install Turnpike as a PWA (Add to Home Screen) for the best experience. Check-ins are stored locally and sync when connectivity is available.
## Schedule