feat: guided tours using Joomla Tour engine #249

New Issue

2026-06-23T16:48:35Z

jmiller commented

2026-06-23 16:48:35 +00:00

Guided Tours

Overview

Interactive guided tours for MokoSuite features using Joomla's built-in Tour engine (com_guidedtours). Tours walk administrators through setup, configuration, and feature usage step-by-step.

Tours to Create

Welcome Tour — first-time setup after install (health token, heartbeat, trusted IPs)
Dashboard Tour — overview of the MokoSuite dashboard (info bar, plugin cards, charts, quick actions)
Firewall Tour — WAF setup, trusted IPs, security headers, auto-ban
DevTools Tour — dev mode, mirror domains, hit resets, version cleanup
Tenant Tour — tenant restrictions, hidden menus, installer lockdown

Architecture

Tour definitions stored as JSON/XML in the component's install SQL or via Joomla's #__guidedtours and #__guidedtour_steps tables
Tours registered during install/update in script.php postflight
Each tour targets specific CSS selectors on the relevant admin pages
Tours auto-launch on first visit (configurable) or available from help menu

Tour Step Structure (per Joomla API)

{
  "title": "Step Title",
  "description": "What this does and why",
  "target": "#css-selector",
  "type": "next|interactive",
  "position": "top|bottom|left|right",
  "url": "/administrator/index.php?option=com_mokosuiteclient"
}

Implementation

Register tours in #__guidedtours table during postflight
Register steps in #__guidedtour_steps for each tour
Use Joomla's native tour UI (no custom JS needed)
Tours should be re-triggerable from the dashboard or help menu

## Guided Tours ### Overview Interactive guided tours for MokoSuite features using Joomla's built-in Tour engine (`com_guidedtours`). Tours walk administrators through setup, configuration, and feature usage step-by-step. ### Tours to Create - **Welcome Tour** — first-time setup after install (health token, heartbeat, trusted IPs) - **Dashboard Tour** — overview of the MokoSuite dashboard (info bar, plugin cards, charts, quick actions) - **Firewall Tour** — WAF setup, trusted IPs, security headers, auto-ban - **DevTools Tour** — dev mode, mirror domains, hit resets, version cleanup - **Tenant Tour** — tenant restrictions, hidden menus, installer lockdown ### Architecture - **Tour definitions** stored as JSON/XML in the component's install SQL or via Joomla's `#__guidedtours` and `#__guidedtour_steps` tables - Tours registered during install/update in `script.php` postflight - Each tour targets specific CSS selectors on the relevant admin pages - Tours auto-launch on first visit (configurable) or available from help menu ### Tour Step Structure (per Joomla API) ```json { "title": "Step Title", "description": "What this does and why", "target": "#css-selector", "type": "next|interactive", "position": "top|bottom|left|right", "url": "/administrator/index.php?option=com_mokosuiteclient" } ``` ### Implementation - Register tours in `#__guidedtours` table during postflight - Register steps in `#__guidedtour_steps` for each tour - Use Joomla's native tour UI (no custom JS needed) - Tours should be re-triggerable from the dashboard or help menu ### Related - DevTools reset tour prompts (#249)

jmiller added this to the v03.00.00 milestone 2026-06-23 16:48:35 +00:00

jmiller commented

2026-06-23 16:48:38 +00:00

Branch created: feature/249-feat-guided-tours-using-joomla-tour-engi

git fetch origin
git checkout feature/249-feat-guided-tours-using-joomla-tour-engi

Branch created: [`feature/249-feat-guided-tours-using-joomla-tour-engi`](https://git.mokoconsulting.tech/MokoConsulting/MokoSuiteClient/src/branch/feature/249-feat-guided-tours-using-joomla-tour-engi) ```bash git fetch origin git checkout feature/249-feat-guided-tours-using-joomla-tour-engi ```

jmiller referenced this issue

2026-06-23 16:49:57 +00:00

feat: required guided tours per user group #251

Sign in to join this conversation.

Priority Medium

Type Feature

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: MokoConsulting/MokoSuiteClient#249