Umbra
← All docs

Inline help drawers

Every major view has a right-side help drawer with token documentation and click-to-run examples.

Last updated May 27, 2026

What it is

A consistent right-side drawer pattern available from a small (?) button on every major page. Slides in over the current view; the content is page-specific: token grammar table, click-to-run example queries, conceptual model walkthrough, troubleshooting common gotchas.

What it produces

Per page, a layered drawer with:

  • Token reference table: every token applicable to this view, with example value + short description
  • Click-to-run examples: real, ready-to-run queries an operator actually uses (each click navigates the page to that query)
  • Concept doc: the longer explainer for the view’s data model (e.g. “what does liveness:gone mean?“)
  • Troubleshooting: the three most-common operator gotchas with answers

What to use it for

  • Onboarding new team members without forcing them to read a manual upfront
  • ”Wait, what’s the token for X?” Usually faster than a Google search
  • Click-to-run examples as a discovery aid: “I didn’t know I could ask that”

Why it matters

Documentation that lives in a separate site is documentation nobody reads. The inline drawer pattern means the doc is one click away from the surface that needs it, and the cost of finding it is lower than the cost of guessing.

Why it’s valuable

  • Same drawer pattern everywhere. Services, Hosts, Findings, Targets, Agents, Notifications: same look, same shortcut, same expectation. Train once, use forever.
  • Click-to-run examples ARE the docs. Reading “filter by product:apache” is less useful than clicking a chip that does it.
  • Per-page scope. Each drawer only documents the tokens for this view, no scrolling through 80 unrelated tokens.

How to use it

Click the small (?) icon at the top-right of any list page. The drawer slides in from the right. Click anywhere outside or the close button to dismiss.

Keyboard: ? opens, Esc closes.