Operator-facing help for the SPA: inline hints at the point of use and a /help hub for longer walkthroughs. Tracks #135.
| Area |
Status |
Notes |
Content manifest (src/content/help/) |
In progress |
Typed help IDs; all copy in topic files |
Help UI primitives (src/components/help/) |
In progress |
HelpPopover, HelpAlert, FormatVarianceTable, HelpMarkdown |
| Inline help (P1/P2 surfaces) |
In progress |
Per help-surface-plan |
Help hub (/help) |
In progress |
Topic pages + glossary |
| Cross-links from inline → hub |
In progress |
learnMoreSlug on each entry |
- Content:
src/content/help/manifest.ts — single registry; routes reference HelpTopicId values, never hard-code prose.
- Variance:
src/content/help/radioVariance.ts — OpenGD77 / DM32 / CHIRP comparison tables for export-sensitive features.
- UI:
HelpPopover (field), HelpAlert (page), FormatVarianceTable (format divergence).
- Hub:
/help index + /help/:topicId renders markdown bodies from the manifest.
- Add entry to the appropriate
src/content/help/topics/*.ts file.
- Register in
manifest.ts if using a new topic file.
- Wire
helpId on HelpHint, HelpAlert, or getHelpShort() for descriptions.
- Add
body markdown for hub long-form; set learnMoreSlug for popover links.
- Follow help-writing-styleguide.md.