guide Step

The guide step walks users through instructions one at a time. Useful for troubleshooting or setup.

Syntax

- guide:
    goal: "Connect your device to WiFi"
    instructions:
      - "Open Settings on your device"
      - "Select WiFi"
      - "Connect to your home network"
    success:
      - done: "Great, you are connected"
    failure:
      - escalate: support
    max_attempts: 2
    name: "WiFi Setup"

Properties

Property	Type	Required	Description
goal	string	Yes	What you are trying to accomplish
instructions	string[]	Yes	Steps to walk through
success	target	No	What to do on success
failure	target	No	What to do on failure
max_attempts	number	No	Retry limit per instruction (default 2)
name	string	No	Human readable step name
verify	object	No	Reserved for future action based verification

Example

- guide:
    goal: "Reset your device"
    instructions:
      - "Unplug the device"
      - "Wait 30 seconds"
      - "Plug it back in"
    success:
      - done: "Your device should be back online"
    failure:
      - escalate: support