docs: add comprehensive operational guide, views breakdown, and architecture decision records #18

Open

gabogg wants to merge 1 commit from docs/system-workflow-and-views-guide into main

gabogg commented

2026-09-24 12:52:56 +00:00

Owner

Summary

Comprehensive system documentation covering the complete operational lifecycle, detailed view mechanics, user guides, and foundational Architecture Decision Records (ADRs).

docs/
├── USER_GUIDE.md             # End-to-end operator manual & step-by-step workflow
└── adr/
    ├── 0001-direct-supabase-client-architecture.md
    ├── 0002-debounced-autosave-with-loading-guard.md
    ├── 0003-client-side-multipage-pdf-and-whatsapp-export.md
    └── 0004-normalized-relative-pin-coordinates.md
CONTEXT.md                     # Enhanced domain glossary with view and role definitions
README.md                      # Updated architectural summary and view breakdown

Operational Workflow: Documents the 24-hour lifecycle (Morning shift initialization, command leadership assignment, automated roster vs manual distribution, floor plan pin placement, pre-opening alert at 9:50/11:50, shift handover at 18:00, official A4 PDF & WhatsApp export, and audit calendar verification).
Views Breakdown: Detailed analysis of all 8 application views and their mechanics.
Architecture Decision Records: 4 formal ADRs documenting key engineering decisions.

Evidence

Before: Sparse documentation missing view breakdowns, operational workflows, and formal ADRs.
After: Complete documentation across README.md, CONTEXT.md, docs/USER_GUIDE.md, and docs/adr/. All 69 base tests passing and production Vite build passing with 0 errors.

Merge Danger

Door: two-way

Documentation-only additions; zero runtime risk.

Blast Radius: none

## Summary Comprehensive system documentation covering the complete operational lifecycle, detailed view mechanics, user guides, and foundational Architecture Decision Records (ADRs). ```text docs/ ├── USER_GUIDE.md # End-to-end operator manual & step-by-step workflow └── adr/ ├── 0001-direct-supabase-client-architecture.md ├── 0002-debounced-autosave-with-loading-guard.md ├── 0003-client-side-multipage-pdf-and-whatsapp-export.md └── 0004-normalized-relative-pin-coordinates.md CONTEXT.md # Enhanced domain glossary with view and role definitions README.md # Updated architectural summary and view breakdown ``` - **Operational Workflow**: Documents the 24-hour lifecycle (Morning shift initialization, command leadership assignment, automated roster vs manual distribution, floor plan pin placement, pre-opening alert at 9:50/11:50, shift handover at 18:00, official A4 PDF & WhatsApp export, and audit calendar verification). - **Views Breakdown**: Detailed analysis of all 8 application views and their mechanics. - **Architecture Decision Records**: 4 formal ADRs documenting key engineering decisions. ## Evidence - **Before:** Sparse documentation missing view breakdowns, operational workflows, and formal ADRs. - **After:** Complete documentation across `README.md`, `CONTEXT.md`, `docs/USER_GUIDE.md`, and `docs/adr/`. All 69 base tests passing and production Vite build passing with 0 errors. ## Merge Danger **Door:** two-way Documentation-only additions; zero runtime risk. **Blast Radius:** none

gabogg added 1 commit

2026-09-24 12:52:56 +00:00

docs: add comprehensive operational guide, views breakdown, and ADRs 088865309c

This pull request can be merged automatically.

You are not authorized to merge this pull request.

View command line instructions

Checkout

From your project repository, check out a new branch and test the changes.

git fetch -u origin docs/system-workflow-and-views-guide:docs/system-workflow-and-views-guide

git switch docs/system-workflow-and-views-guide

Merge

Merge the changes and update on Forgejo.

Warning: The "Autodetect manual merge" setting is not enabled for this repository, you will have to mark this pull request as manually merged afterwards.

git switch main

git merge --no-ff docs/system-workflow-and-views-guide

git switch docs/system-workflow-and-views-guide

git rebase main

git switch main

git merge --ff-only docs/system-workflow-and-views-guide

git switch docs/system-workflow-and-views-guide

git rebase main

git switch main

git merge --no-ff docs/system-workflow-and-views-guide

git switch main

git merge --squash docs/system-workflow-and-views-guide