Creating a Guide
How to build an interactive guide from scratch using the visual editor.
Guides are built using a visual editor that lets you add steps, fill them with blocks, and wire up branching logic. You can preview your work at any point using the built-in runner.
How to Create a Guide
Open the Guides Tab
Navigate to your companion's settings page and click the Guides tab. This shows all existing guides for that companion in a grid layout.
Click Create
Click the Create button to start a new guide. You will be prompted to enter a name and description for your guide. The guide is created in Draft status by default.
Add Steps
Your guide starts with a single empty step. Click Add Step to add more steps to the workflow. Each step represents one screen that the user will see when they go through the guide.
Add Blocks to Each Step
Click on a step to open it, then add blocks to define what the user sees. You can add multiple blocks to a single step -- for example, a message block followed by a question block. See Blocks for details on each block type.
Configure Branching
If you use Question blocks, you can configure branching so that each answer option routes the user to a different step. This lets you create non-linear workflows that adapt to user input.
Preview with the Runner
Use the built-in guide runner to preview your guide exactly as users will experience it. The runner walks through each step, renders all blocks, and follows your branching logic.
The Guide Editor
The editor provides two ways to view your guide:
List View
The default view shows your steps as a vertical list. Each step is a collapsible card that displays its blocks. This view is best for editing content and adding blocks to individual steps.
Graph View
The graph view displays your guide as a visual flowchart. Steps appear as nodes, and branching connections are shown as edges between them. This view is best for understanding the overall flow and verifying that your branching logic is correct.
You can switch between views at any time -- your content is the same in both.
Editing Features
- Undo / Redo -- Use Ctrl+Z (or Cmd+Z on Mac) to undo changes and Ctrl+Shift+Z (or Cmd+Shift+Z) to redo. The editor keeps a full history of your changes within the current session.
- Auto-save -- Changes are saved automatically as you work. There is no manual save button -- your progress is always preserved.
- Drag and drop -- Reorder steps by dragging them to a new position in the list view.
New guides are created as Drafts. They will not be visible to users until you publish them. See Publishing & Sharing for details.
Last updated on