Glossary

Help Tutorials

Glossary

  • Auto-open — the panel's behaviour of opening automatically on first visit to an unread tutorial. Controlled per-user by localStorage["help-tutorials-auto-open"]; defaults ON.
  • defaultTutorialsEN() — Go function in backend/internal/core/admin/help_tutorials.go that returns the slice of seed tutorials (English content, seeded under the requested language).
  • Got it — the green footer button in the help panel. Marks the page as read and closes the panel.
  • help_tutorials table — the per-tenant Postgres table storing tutorial rows, unique on (page_key, language).
  • help_tutorial_reads table — the per-tenant table tracking which (user_id, page_key) pairs have been marked read.
  • HelpButton — the floating circular button at bottom-right of admin pages (frontend/src/components/admin/HelpButton.tsx).
  • HelpPanel — the right-sliding side panel that renders the tutorial content (frontend/src/components/admin/HelpPanel.tsx).
  • Impact — the one-line "what changes if I flip this?" callout shown for each settings_help entry.
  • manage_help — fine-grained privilege for tutorial CRUD. Wave 11 split this off from manage_settings.
  • manage_settings — the omnibus settings-admin privilege; also grants tutorial CRUD as a superset.
  • page_key — the dotted route identifier used to link a tutorial to an admin page. Computed by getPageKey(pathname) in frontend/src/lib/help-tutorials.ts.
  • Preview — the editor's "render-this-tutorial-without-saving" mode; opens the same <HelpPanel> from React state instead of DB.
  • Resolver — the getPageKey(pathname) function — converts a browser path into the dotted key, stripping UUID / numeric segments unless followed by edit or view.
  • Seed / Seeder — the process of populating defaults via POST /admin/help-tutorials/seed. Idempotent; fills gaps only.
  • settings_help — JSONB array of { field_name, label, description, impact } entries shown in the Settings tab of the panel.
  • steps — JSONB array of { step, title, content, image_url? } shown in the Overview tab as a numbered list.
  • Tutorial-aware page — an admin page that calls getPageKey() and whose key has at least one row in help_tutorials. Tutorial-unaware pages don't render the help button.
  • Unread pulse — the green ping dot on the help button signalling an unread tutorial exists for the current page.
  • video_url — optional tutorial field; YouTube + Vimeo embed in-panel, anything else falls back to external link.