How-to

Using the help panel

How contextual help works, how to search, and where to find everything.

The help panel brings docs into the app. Opening it on any page shows you documentation relevant to what you're looking at — you don't have to leave your current workflow to find out how something works.

Opening the panel

Tap the help icon in the top bar, or press ⇧+? from anywhere in the app. The panel anchors alongside the current page so your workflow stays in view.

What's new

When a release ships — or there are unread updates — a gift icon appears in the top bar alongside the help icon. Tap it to jump straight to the Updates section of the panel.

What you see first

The top of the panel shows About this page — a short list of docs specifically bound to the route you're on. For example:

  • On the Calendar, you'll see switching views, rescheduling, blocking time, and filtering
  • On a booking detail, you'll see rescheduling, deleting, managing vouchers, and the booking lifecycle concept

These aren't all the docs that exist — just the ones most likely to help someone stuck on this specific page. The order reflects priority: how-tos most relevant to the current action first, references and concepts below.

Searching

The search field matches doc titles, descriptions, and content. Use it when:

  • You know what you want (search by a term like "amend claim" or "immunisation history")
  • The contextual docs don't cover your question
  • You want to find a doc from another area without navigating

Browsing the tree

Below search, the full Diataxis structure is available:

  • Guides — how-to docs for every area
  • Reference — enumerations, tables, structured references
  • Concepts — explanations of the model

Drill into a section to see all docs there. This is how to build a fuller mental model — "I know bookings well, but I want to read about how encounters work".

What's different in-app vs the public site

The same docs live on docs.lightplatform.com.au and in the in-app panel. The in-app version is more interactive — contextual route binding, anchored to the thing you're doing — but nothing is missing from the docs themselves. You can follow docs equally well from either surface.

If a doc is wrong or missing

Docs evolve alongside the platform. At the bottom of every doc page, tap Suggest an improvement to flag it as unclear, inaccurate, missing, or other — your feedback goes straight to the docs team along with the page you were viewing. Don't work around a bad doc; inaccurate help is worse than no help.