Annotations

You can use notes to annotate your machine, positioned anywhere inside your machine. Notes are useful for information or comments you want to add to your machine that are only visible inside Stately Studio and not included when you export as code.

Notes are formatted with Markdown so you can add links, images, and other formatting to your annotations.

Unlike descriptions, notes don’t need to be connected to a state or transition and can be added or positioned anywhere inside your machine.

Add notes to your machine

You can add notes anywhere on your machine from Design and Simulate mode, but you can only edit them in Design mode.

Notes are unrelated to a state or transition. Still, their layout position is connected to the closest root or parent state when you create them, which helps give your notes enough space in the auto layout.

• Use the plus icon button in the canvas tools and choose Note.
• Right-click anywhere on the canvas and choose Add note.

Edit and delete notes

• Double-click or use the Enter key to edit the contents of a note.
• Use the Backspace key to delete the selected note.