Skip to main content

Get help in-app

Goal​

You'll find the answer to a "how does this work?" question without leaving the app. The Help panel carries the same documentation you're reading now: every guide is listed, searchable as you type, and one click away from the full page on docs.measured.cloud. On the main screens, a ? at the right of the page header opens the panel straight to that screen's guide.

Prereqs​

  • Any signed-in role. The Help panel shows documentation only — no data from your workspace — so every seat, including viewer, can open it.
  • A keyboard or a pointer. The panel is fully keyboard-accessible: it keeps focus inside while open, closes on Esc, and returns focus to where you were.

Steps​

Open the Help panel​

  1. Click your name at the bottom of the left sidebar to open the user menu, then choose Help.
  2. The panel slides in from the right. It opens on How it works: the product's workflow in order — data sources, data assets, rules, validations, schedules, execution runs, results, alerts — with a one-line summary of each and a link to its guide.
  3. Below that, Browse the docs lists every page, grouped as on the docs site: Getting started, Concepts, How-to guides, and Reference.

Search the docs​

  1. Type in Search the docs at the top of the panel. Results update as you type; partial words work, so sched finds the scheduling guides.
  2. Each result shows the guide's title and summary, plus the sections of the page that matched, as links. Click a section to open the guide scrolled to that heading.
  3. Nothing matches? The panel offers Search the full text on the docs site, which runs the same query against every word of every page.

Jump to the guide for the screen you're on​

The Validations and Alerts pages carry a ? at the right of their page header. Click it and the panel opens with that screen's guide pinned at the top under On this screen, with its main sections listed as jump links. On Data sources, the ? opens the Privacy Agent guide, for connecting a database behind your firewall.

Open the full documentation or the API reference​

Every title and section link opens docs.measured.cloud in a new tab. The panel's footer links to the Docs home and to the API reference: the complete, generated reference for every REST endpoint.

Close the panel​

Press Esc, click the ✕ in the corner, click outside the panel, or use Close this panel in the footer. Focus returns to where it was before you opened it.

Verify​

  1. From any page, open the user menu, choose Help, and confirm the panel lists the eight workflow steps under How it works.
  2. Type alert in the search box: Alerts and Set up Slack or email alerts are among the results.
  3. Open Validations and click the ? in the page header: the panel opens with Validations under On this screen.
  4. Click any guide title: the matching docs page opens in a new browser tab.

How the panel stays current​

The panel isn't a separate, hand-written help system. It's built from the same documentation files as docs.measured.cloud, so when a guide is added or updated, the panel lists the new version from the next release. Retired pages that are kept only so old links still work are left out.

See also​