إنتقل إلى المحتوى الرئيسي

Guided Tutorials

Canopy includes a built-in guided tutorial system that walks you through key workflows step-by-step, directly inside the application. No separate documentation tab or sandbox environment needed — the tutorial runs on your live instance with your real data.

Accessing the Tutorial Hub

Open the user menu (profile icon, top-right) and select Tutorials, or navigate directly to /onboarding. The page has two tabs: Tutorials (the per-user guided journeys described below) and Platform Tutorial (a shared, instance-wide rollout checklist — see Platform Tutorial).

The Tutorials tab lists every available journey with its current progress and a status chip:

StatusMeaning
Not startedYou have not begun this journey
In progressYou have completed some steps
CompletedAll steps are done

Click Start, Continue, or Restart to begin.

Available journeys

Getting Started

A four-step overview of the core Canopy workflow: visit the dashboard, browse the inventory, create your first card (sandboxed — no real data written), and open a report.

Business Process Management

Learn how to connect capabilities, business processes, and applications using the BPM module. Opens the Capability Catalogue, selects a capability, navigates to a process flow editor, and links an application to a BPMN task element (sandboxed).

Application Portfolio Review

A guided tour of the portfolio analysis workflow: open the Portfolio report, apply a lifecycle filter, drill into a card, and finish at the Data Quality report.

How journeys work

The tutorial panel

While a journey is active, a floating panel appears in the bottom-right corner of the screen. It shows:

  • The journey title and icon
  • A progress bar and step counter (e.g. "2 of 4 steps")
  • A list of all steps, with completed steps checked and the current step highlighted with its description

Steps complete automatically — there is no "Mark Done" button. Canopy detects the correct action (navigating to a route, clicking a specific element, or completing an API call) and advances to the next step on its own.

The spotlight overlay

When a step has a specific target element (a navigation link, a button, a table row), Canopy dims the rest of the screen and leaves that element fully interactive. A gentle pulsing ring animates around the highlighted element to draw your attention to it.

If you click anywhere on the dimmed area, a brief toast message appears at the bottom of the screen reminding you that other actions are paused while the step is active.

Context popups

Some steps display a context popup after they complete. The popup appears in the centre of the screen and provides background information or explains what just happened before the next step begins. You must click Got it to dismiss it — the next step does not start until you do. The popup cannot be closed by pressing Escape or clicking outside it.

Minimising the panel

Click the (minus) icon in the panel header to minimise it to a small floating button. While minimised:

  • The spotlight overlay is removed — you can navigate and interact with the application freely
  • A brief toast message confirms that the tutorial is paused and tells you how to resume
  • Click the school icon button to restore the full panel and resume where you left off

Sandboxed steps

Steps marked as sandboxed (such as "Create a card" in the Getting Started journey) intercept the API call and return a mock response. No real data is written to the database. This lets you practise the interaction safely.

Dismissing a journey

Click in the panel header to stop the current journey. A confirmation dialog appears before discarding progress. Dismissed journeys can be restarted from the Tutorial Hub.

Restarting a journey

From the Tutorial Hub, click Restart on any previously started or completed journey. This clears all progress for that journey and returns it to "Not started". Your progress on other journeys is unaffected.

Platform Tutorial

The Platform Tutorial tab on /onboarding is a structurally different feature from the per-user journeys above. Where a journey is private to you and advances automatically as you interact with the app, the Platform Tutorial is a shared, instance-wide checklist: everyone in your organisation sees and can advance the same progress, and every step is advanced manually by clicking through it — there's no spotlight overlay or auto-detection.

The first (and currently only) Platform Tutorial is Your First 30 Days, based on the Your First 30 Days documentation track. It's organised into four phases, each mirroring one of that guide's pages — Plan Your Rollout, Start With Your Application Inventory, Leverage Reference Catalogues, and Your First Analysis — with 17 concrete steps between them.

Steps must be completed in order: a step is only actionable once every step before it is done, and locked (future) steps are shown greyed out with no quick links until you reach them.

Each step can show any combination of:

  • Quick links — buttons that jump straight to the relevant part of the app (e.g. a pre-filtered Inventory view, the Capability Catalogue, a specific report).
  • A documentation link — opens the exact section of the docs the step is based on, in a new tab.
  • A saved answer — a handful of planning steps (e.g. "Define a narrow scope", "Pick the right first use case", "Commit a single deliverable") ask you to type or select an answer, which is saved for the whole team to see. Once saved, the answer is shown read-only with an Update button to revise it later — editing a saved answer never undoes the step's completion or re-locks later steps.
  • A live indicator — a small, read-only metric computed on the spot from your current data (e.g. how many Application cards are Draft/Approved/Broken, how many Business Capability cards exist at each level, or how many Applications are still unmapped to a capability), so you can see whether you're actually ready to move on rather than guessing.

Because progress is shared, any authenticated user can mark a step complete, update a saved answer, or reset the whole checklist back to the start — there's no admin-only restriction. Use Reset progress at the top of the tutorial if your organisation wants to start the checklist over (this clears every completed step and saved answer for everyone).