What are Help Tutorials?

Help Tutorials

What are Help Tutorials?

Help Tutorials are contextual help cards attached to admin pages by page_key. Open the admin pencil/help icon on any page that has a tutorial wired and you get a numbered walk-through, per-field "what does this do?" hints, and an optional embedded video.

The module ships ~57 seeded tutorials covering the most-trafficked admin surfaces (orders, products, vendors, settings, modules, payments, shipping, taxes, banners, themes, etc.). Tutorials are stored per tenant in the help_tutorials table — each tenant can edit, replace, or extend them without affecting other tenants.

What it solves

  • New admin operators land on a settings panel with 30 fields and no idea which two matter for their flow. The settings_help array lets you annotate the three that do.
  • Vendor-facing admins (vendor staff, partner logins) need a different voice from store-owner admins. Tutorials are language-tagged and tenant-scoped, so you can localise them.
  • Power users want speed; new users want guidance. The "mark as read" mechanism (help_tutorial_reads table) hides the dot on tutorials a user has already opened, so the UI stays clean once they've onboarded.

What it does NOT do

  • It is not a full LMS — there's no completion tracking across users, no quizzes, no analytics on which steps confuse people. Per-user "read" state is the only signal.
  • Tutorials are flat HTML/markdown content + step list; they do not drive the admin UI itself (no spotlight overlays, no forced flows). They open in a side panel.
  • It is not multi-tenant marketing — tutorials live per-tenant, so global content updates require a re-seed (POST /admin/help-tutorials/seed).

Module gating

help-tutorials is a standard module. When OFF the help icon disappears from admin pages and /admin/help-tutorials returns 403 with module_disabled. Existing rows in help_tutorials are preserved — flipping back ON restores the panel.