In-App Help: The Guide Button
In-App Help: The Guide Button
Every admin screen has a Guide button in the header. It opens a side panel with help written for that exact screen, so you can read how to fill in a form while the form stays open beside it.
How it decides what to show
- The help page written for the exact screen you are on.
- If there is none, the help for the closest parent section (for example, all of Delivery → Zones).
- If there is none, the module's overview page.
- If a module ships no help at all, the button does not appear. A help icon that opens generic filler is worse than no icon.
What a guide page contains
- A flow: the order things happen in, for example Geography → Zone → Method → Rate rule.
- Fields: what each field on the form means, in one line each.
- Rules and warnings: the facts that cause most mistakes, such as "a coupon and a promotion are different things".
- Related pages: links to the next guide you are likely to need.
The guide hub
Open /admin/guide to browse every module's help in one place, ordered by the title you see, with search across all pages. The guide ships inside each module with the code it explains, so it is updated together with the software and never needs a separate download.
Privacy
The guide is served from your own server. Nothing about your screens, users or data is sent anywhere when you open it.
Guide or documentation?
| Use | When |
|---|---|
| Guide button | You are on a screen and want to know what a field or button does. |
| This documentation | You want the bigger picture, setup steps across modules, or are not signed in. |
| Video tutorials | You want to see a module working before you start. |
Last updated: 10/5/2026