What this screen is for
This is the index of everything written for people with an account. Help is organised into three kinds:
- Screens
- One page per screen of the product: what it is for, what each control does, what to do next.
- Features
- One page per capability - the free check, each of the thirteen checks, plans, tokens, organisations.
- Concepts
- SPF, DKIM, DMARC and the vocabulary, written for somebody who has never met them before.
The help is in two halves, and this is the account half
Help is split by who needs it, not by subject.
- Here, in your panel
- Everything that only makes sense once you have an account: signing in and signing up, verifying your address, recovering a password, the panel itself, plans and limits, organisations and seats, and API tokens. None of it is published to search engines, and it is reached from Help in the panel header.
- On the public site, at /help/
- The free domain check, each of the thirteen checks, SPF, DKIM, DMARC and the glossary. Those are what somebody reads straight after a check result they did not expect, so they stay readable with no account at all - reached from the site footer and from the check result itself.
Help in the panel header opens the help for the panel; the small arrow beside it opens a menu with the rest. The menu is a real disclosure: it opens on click or on Enter, closes on Escape, and works with a keyboard, a screen reader and a touch screen. Nothing here needs a mouse hover.
Searching
The search box on this page searches the whole body of every help page, not just the
titles - so searching for the wording of an error, or a tag such as rua, finds
the page that explains it. A search can be linked to directly by adding
?q= and your words to this page's address.
Each half searches its own half: this page searches the account help, and the public help index searches the public help. Neither is a subset of the other.
Search needs JavaScript. Without it the full list below still works, and every page is still reachable.
What the help does not do
It does not describe anything that is not built. Where a capability is planned rather than present, the page says so and links to the roadmap. If you find help describing something that does not exist, that is a defect - please report it to support@mailguardhq.com.
Help is currently written in English only.