Files
ottyl/tickets/021-docs-contextual-help.md
T

1.5 KiB

021 — Contextual "?" help icons linking into Docs

Summary

Every major UI section should have a "?" icon that opens the Docs panel scrolled to (and highlighting) the relevant section, instead of the user having to find it themselves in the Docs accordion.

Scope

  • A small reusable HelpIcon/HelpLink component: renders a "?" affordance, accepts a target docs section id, and on click opens the Docs panel (NavMenu's docs panel / Docs.tsx) navigated to that section.
  • Add one to each major component per the README's block diagram: FilterBar, LogTimeline, LogPreview, Metrics, Dashboards, and NavMenu's own Settings/Presets panels.
  • Docs panel: support being opened with a target section id (not just opened to the top/last-open accordion item) — expand the right accordion section and scroll it into view.
  • "Flash" behavior: when navigated to via a "?" icon, the target paragraph/section visually flashes (e.g. a brief background-color pulse) so the user's eye finds it immediately, then settles back to normal styling.

Acceptance criteria

  • Clicking a "?" icon on any of the listed components opens Docs, expands the correct accordion section, scrolls it into view, and it visibly flashes.
  • Clicking the same icon twice in a row re-triggers the flash (not just a no-op because the panel is already open to that section).
  • Docs opened normally (via the NavMenu Docs button, not a "?" icon) behaves as today — no flash, no forced section.

Depends on

None — builds on the existing Docs.tsx / NavMenu docs panel.