User Guides
Last updated
Was this helpful?
Last updated
Was this helpful?
By default, all devices use the same provisioning/claiming instructions, but occasionally, the device may require a specific Installation Guide, Troubleshooting link or Device Preparation Instructions. You can set them up for each Template separately:
Go to Template
Open the User Guides tab
Click on the item you’d like to modify
You can reset the Guides to default by clicking the Reset To Default button.
This feature is available with our Enterprise plan.
To ensure your guide is clear and well-structured, we support Markdown syntax. Below are the essential Markdown elements you can use:
Use Headlines to structure your guide into individual steps.
Start each main step with an H1 headline (#).
For sub-steps, use H2 (##) and H3 (###) headlines.
Example:
Use Ordered Lists for steps that must follow a specific order.
Use Unordered Lists for items that do not require a particular order.
Example:
Use Links to provide additional resources or references.
Example:
Use Images to provide visual aids for better understanding.
Example:
4000 characters max
10 steps max
To ensure your instructions are clear and well-structured, we support Markdown syntax. Below are the essential Markdown elements you can use:
Use H1 (#), H2 (##) and H3 (###) to structure your instructions.
Use Ordered Lists for steps that need to follow a specific sequence.
Use Unordered Lists for items that do not require a particular order.
Use Links to provide additional resources or references.
Use Images to provide visual aids for better understanding.
Example:
400 characters max
By using these Markdown elements, you can create a clear, structured, and informative Device Preparation Instructions.
max length of the Action Title is 40 characters
Sometimes, users may need assistance during the device pairing. Provide a link that will help them get the device connected. You can use mailto:mail@example.com where ‘’ is your support contact if you need users to contact you directly, or you can also use tel: placeholder to trigger a phone call.
