You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
F18: In-app help — user guide + glossary in the SPA #71
Part of Phase 1.1 (epic #14). Owner request (2026-07-17): the system needs usage documentation and the key concepts/glossary available inside the SPA, not just in the repo — and it must stay current with every backend/frontend change (companion rule added to AGENTS.md).
Scope
Help route + nav entry in the SPA (/help), fully client-side content (no backend).
User guide sections, one per screen, written for a farm operator (not a developer):
The daily loop: record entry → submit → lots → stock → order → confirm (spec §7 one-liner as the anchor).
Daily entry (draft vs submitted, copy-from-yesterday when it lands, blank vs zero).
Flocks (lifecycle Active/Depleted/Archived, reactivate as the undo, bird ledger, cull vs adjustment).
Grades (saleable flag, deactivation semantics).
Stock (available vs restricted).
Inventory (items/categories, unit lock, purchases → lots, feed usage, corrections via adjustments/discards).
Customers & Sales (draft orders, confirm = FIFO allocation, void = undo with stock return, cancel vs void).
Glossary — farmer-facing rendition of specs/product/GLOSSARY.md (repo glossary stays the canonical spec-language version; the in-app one favors plain words). Cross-linked from screen sections.
Searchable/anchored (simple heading anchors fine; no search infra needed).
Maintenance rule (lands with this slice, applies forever)
AGENTS.md: every slice that adds/changes user-visible behavior updates the Help page + in-app glossary in the same PR — reviewers treat missing help updates like missing tests.
Every current screen has a help section reachable in ≤2 clicks; glossary terms match GLOSSARY.md meanings; the corrections map covers reactivate/void/adjust accurately.
Part of Phase 1.1 (epic #14). Owner request (2026-07-17): the system needs usage documentation and the key concepts/glossary available inside the SPA, not just in the repo — and it must stay current with every backend/frontend change (companion rule added to AGENTS.md).
Scope
/help), fully client-side content (no backend).specs/product/GLOSSARY.md(repo glossary stays the canonical spec-language version; the in-app one favors plain words). Cross-linked from screen sections.Maintenance rule (lands with this slice, applies forever)
AGENTS.md: every slice that adds/changes user-visible behavior updates the Help page + in-app glossary in the same PR — reviewers treat missing help updates like missing tests.
Out of scope
Acceptance