The guides for this platform are written by the vendor and ship inside each release. You read them in two places: the help drawer inside the admin, and a public documentation site.
The help drawer
On any admin page that has a guide, the help button opens a panel beside the page. Pages with no guide do not show the button.
- It opens the guide for the page you are on. A sub-page, such as one record, shows its parent page's guide, and a page without one of its own shows the plugin's overview.
- How do I… lists the task guides for this page, and More in this section lists the plugin's other guides. Press one to read it in the drawer.
- The search box searches all guides at once; matching walkthrough videos are listed separately. Searching works with no network, no database and no AI service, because the guides ship inside the release.
- Read the full guide opens the plugin's section on the documentation site in a new tab.
- Screenshots are removed in the drawer and appear on the documentation site only, so every guide stands on its text.
- If the plugin is not in your plan, a note says so and the guide is still shown so you can see what it does.
- The guide uses your admin language where it exists, otherwise English, otherwise Farsi.
The documentation site
The same guides, grouped by area, with a sidebar, search, "How do I…" lists on each plugin's page, and the date each guide last changed. It is served from the operator's own host (the vendor's documentation address); a client install links to it rather than serving it.
Correcting a live guide: overrides
This is for the operator only. The guides are files that ship with each release, and an override is a way to correct a sentence that is live and wrong right now, without waiting for the next release. It is not a second authoring system: a non-urgent change belongs in the guide file, so the published text stays the single source of truth. See Overriding a Guide.
Where an override is visible
Only on the documentation site, where it is served. The drawer reads the guides that shipped inside the release, not the database, so an override never reaches the drawer; that text stays as it was until the next release.
Each field falls back on its own
Change only the title, and the summary and body keep following the published text through later releases.
What a stale override is
Every override remembers which version of the text it was written against. When the published article later changes, the two no longer match and the override shows as stale. It still wins, but it is visibly hiding newer text. The editor shows the published text so you can update your edit or restore the published version.
Search follows your correction
An override changes what is found as well as what is shown: after you correct a word, searching for the new word finds the article and the replaced wording no longer does. This applies to the documentation site; the drawer searches the shipped guides.
Permissions
Read (kb.read) lets you see the guides; Manage (kb.manage) lets you create and remove overrides. The Admin role has both; the Editor role can read. Help is never withheld by plan.