Skip to content
Menu
OpenD Documentation
Version 0.1
Sign in

Check context help in the help lab

See what every help key and route resolves to for each reader, and click through the real help widget, before you publish.

About this task

Host apps open help by context key or by their current path. The help lab, served by the previewer, lists every app, key and route in the project with the topic it resolves to for the reader you are previewing as.

  1. Start the previewer and open http://127.0.0.1:4000/_opend/help-lab.
  2. Read the table for each app.

    Each key shows the topic it opens. When the reader cannot see the topic the key names, the lab shows where it falls back to, for example (via parent: tenants) or (via default: overview). nothing visible means the reader gets no help for it at all.

  3. Type a host-app path, such as /tenants/acme, into Try a host-app path and choose Resolve.
    The lab shows the topic that path opens for the current reader.
  4. Choose Open in widget next to a key to open the real help panel.
  5. Switch Preview as and check again for each kind of reader.

Results

When every key opens a topic each reader can see, publish. To learn how keys, routes and fallback work, see Context-sensitive help in your apps.