Skip to content

docs: rewrite manual to match current UI#81

Closed
exhuma wants to merge 3 commits into
release/2026.4.1from
docs/update-manual
Closed

docs: rewrite manual to match current UI#81
exhuma wants to merge 3 commits into
release/2026.4.1from
docs/update-manual

Conversation

@exhuma

@exhuma exhuma commented Apr 28, 2026

Copy link
Copy Markdown
Owner

Summary

This PR brings the in-app manual up to date with the current Vue 3 / Vuetify 3 application.

What changed

Manual content (src/assets/manual/)

  • Public — Removed stale references to three separate dashboard modes (combined/separate/legacy). The dashboard is now a single route-grouped track view with an inline scoreboard. Removed Facebook/Google-only login mention; documents the current username + password dialog. Login button description updated.
  • Staff — Rewrote Station Dashboard section to match the new layout: side strips showing neighbouring station states, navigation bar, text filter, team cards with Score + Q-Score + State + Save, and the collapsible "Done" accordion. Added a tips section. Updated state table to include the "Unreachable" state.
  • Registered Users — Rewritten to reflect current gallery upload flow and the Uploads management page.
  • Admin — Updated Station List section to document station ordering and the clipboard-icon shortcut. Updated Team Panel fields. Removed outdated warning about route management being "tricky". Added Audit Log and User Management sections with accurate current descriptions.

Screenshot images (public/manual/images/)

All existing screenshots were outdated. They have been replaced with SVG wireframe placeholders that accurately represent the current mobile UI layout and component structure. These should be replaced with real Playwright screenshots once the Playwright MCP session is stable.

Bug fix (src/App.vue)

The login dialog username field had the label "Enter a new username" — this was clearly copy-paste from the user creation dialog. Fixed to "Username".

Images that are no longer referenced

separate-dashboard.png and legacy-dashboard.png — these dashboard modes no longer exist in the codebase and have been removed from the documentation. The files remain on disk but are not referenced.

Next step

Replace the SVG placeholders with real mobile screenshots (390×844 viewport) once the Playwright MCP browser can be started successfully.

opencode[bot] added 2 commits April 28, 2026 07:24
- Rewrote all four manual sections (public, staff, user, admin) to
  accurately reflect the current Vue 3 / Vuetify 3 UI:
  - Removed stale references to separate/legacy dashboard modes
  - Removed Facebook/Google-only login; documents username+password flow
  - Updated dashboard description to route-grouped track view with scoreboard
  - Updated station dashboard docs to match new layout (side strips,
    nav bar, Done accordion, Q-Score field)
  - Updated station list to reflect mobile card layout
  - Updated team panel to match current form fields
  - Clarified station manager vs admin permissions for station dashboards
- Replaced all screenshot images with accurate SVG wireframe placeholders
  (to be replaced with real screenshots once Playwright is available)
- Fixed bug: login dialog username field label was 'Enter a new username'
  instead of 'Username' (src/App.vue)
All 14 manual images are now real mobile screenshots (390×844) taken
from the live dev environment with demo data (4 teams across 2 routes).
@exhuma exhuma changed the base branch from develop to release/2026.4.1 April 28, 2026 06:08
Replace test station names (foo, ergerg, bar, 'This is a station
with long name') with Town Square, Old Mill Bridge, Forest Lookout,
and Finish Line.
@exhuma exhuma deleted the branch release/2026.4.1 May 18, 2026 06:06
@exhuma exhuma closed this May 18, 2026
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