Skip to content

Commit 753be2e

Browse files
sticky notes doc (#1157)
* sticky notes changelog * add sticky note doc * add tip in the flow quickstart * fix changelog link --------- Co-authored-by: Henri Courdent <122811744+hcourdent@users.noreply.github.com>
1 parent 932f833 commit 753be2e

File tree

11 files changed

+141
-8
lines changed

11 files changed

+141
-8
lines changed

changelog/2025-11-20-sticky-notes-in-flows/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,5 +11,5 @@ features:
1111
'Group notes that anchor around a group of nodes to explain sections or logical blocks.',
1212
'Drag and position notes freely to annotate your workflow.'
1313
]
14+
docs: /docs/flows/sticky_notes
1415
---
15-
15.2 KB
Loading
50.9 KB
Loading
17.4 KB
Loading
36.3 KB
Loading

docs/flows/1_flow_editor.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -207,6 +207,12 @@ The Flow editor has the following features which are the subject of specific pag
207207
description="When a step is mocked, it will immediately return the mocked value without performing any computation."
208208
href="/docs/flows/step_mocking"
209209
/>
210+
<DocCard
211+
color="teal"
212+
title="Sticky notes"
213+
description="Annotate flows with documentation using free notes and group notes."
214+
href="/docs/flows/sticky_notes"
215+
/>
210216
</div>
211217

212218
<br />

docs/flows/24_sticky_notes.mdx

Lines changed: 119 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,119 @@
1+
import DocCard from '@site/src/components/DocCard';
2+
3+
# Sticky notes
4+
5+
Sticky notes allow you to annotate flows with documentation, comments, and organizational information directly on the flow canvas. Notes help document workflow logic, add TODOs, or explain complex sections to team members.
6+
7+
<video
8+
className="border-2 rounded-lg object-cover w-full h-full dark:border-gray-800"
9+
controls
10+
src="/videos/sticky_notes_intro.mp4"
11+
/>
12+
13+
<br />
14+
15+
There are two types of sticky notes:
16+
17+
- **Free notes**: Can be placed anywhere on the canvas for general comments or documentation
18+
- **Group notes**: Attached to a selection of nodes to document specific workflow sections
19+
20+
## Creating sticky notes
21+
22+
### Free notes
23+
24+
Create free notes to add general documentation or comments anywhere on the flow canvas.
25+
26+
**Method 1: Toolbar button**
27+
28+
1. Click the sticky note button in the top toolbar
29+
2. Drag and drop on the canvas to position the note
30+
31+
**Method 2: Context menu**
32+
33+
1. Right-click anywhere on the canvas
34+
2. Select "Add sticky note" from the context menu
35+
36+
![Sticky notes interface](../assets/flows/sticky_notes_interface.png 'Sticky notes interface - toolbar with sticky note button and toggle')
37+
38+
### Group notes
39+
40+
Group notes attach to multiple selected nodes to document specific workflow sections or logical blocks.
41+
42+
**Creating group notes:**
43+
44+
1. Enter selection mode by clicking the cursor/hand button in the top-right of the flow pane
45+
2. Select multiple nodes by clicking and dragging or clicking individual nodes while holding Shift
46+
3. Click "Create group note" button that appears when nodes are selected
47+
48+
**Selection mode tips:**
49+
50+
- In selection mode: Hold Ctrl/Cmd to temporarily pan the canvas
51+
- In pan mode: Hold Ctrl/Cmd to temporarily select nodes
52+
53+
![Group note example](../assets/flows/group_note_example.png 'Group note attached to multiple flow nodes')
54+
55+
## Managing sticky notes
56+
57+
### Editing content
58+
59+
Double-click any note to edit its content. Notes support GitHub-flavored Markdown (GHMd) for formatting.
60+
61+
### Customizing appearance
62+
63+
Each note has an action bar in the top-right corner with the following options:
64+
65+
- **Color picker**: Change note color (supports both light and dark themes)
66+
- **Lock icon**: Lock the note to prevent accidental editing or movement
67+
- **Delete button**: Remove the note from the flow
68+
69+
![Sticky note action bar](../assets/flows/sticky_note_action_bar.png 'Action bar with color picker, lock, and delete buttons')
70+
71+
### Positioning notes
72+
73+
Drag notes freely around the canvas to position them where most relevant. Locked notes cannot be moved until unlocked.
74+
75+
## Hiding and showing notes
76+
77+
Use the toggle button in the top-left of the flow pane to hide or show all sticky notes. This is useful when you need a clean view of the flow logic or when presenting to stakeholders.
78+
79+
## Free note example
80+
81+
Free notes are ideal for:
82+
83+
- General flow documentation
84+
- TODO items for future improvements
85+
- Warnings or important considerations
86+
- Links to related resources or documentation
87+
88+
![Free note example](../assets/flows/free_note_example.png 'Standalone free note with sample content')
89+
90+
## Working with group notes
91+
92+
Group notes automatically maintain their association with the selected nodes. However, there are some limitations when editing the grouped nodes:
93+
94+
**To modify nodes in a group note:**
95+
96+
- **Option 1**: Delete the note, make your node changes, then create a new group note with the updated selection
97+
- **Option 2**: Edit the flow directly in YAML/JSON format to modify the grouped nodes while preserving the note
98+
99+
Group notes are particularly useful for:
100+
101+
- Documenting complex logic blocks
102+
- Explaining error handling sections
103+
- Describing data transformation steps
104+
- Marking deprecated or experimental features
105+
106+
<div className="grid grid-cols-2 gap-6 mb-4">
107+
<DocCard
108+
color="teal"
109+
title="Flow editor components"
110+
description="Details on the flow editor's major components including toolbar and canvas features."
111+
href="/docs/flows/editor_components"
112+
/>
113+
<DocCard
114+
color="teal"
115+
title="Testing flows"
116+
description="Iterate quickly and get control on your flow testing."
117+
href="/docs/flows/test_flows"
118+
/>
119+
</div>

docs/flows/3_editor_components.mdx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,9 @@ Here are the different options available in the toolbar:
3434
- **Tutorial button**: follow the tutorials, reset them or skip them.
3535
- **Diff**: view the diff between the current and the last [version](../core_concepts/0_draft_and_deploy/index.mdx) of the flow.
3636
- **AI Builder**: [build flow with AI](./17_ai_flows.mdx).
37+
- **Sticky notes button**: add [sticky notes](./24_sticky_notes.mdx) to annotate the flow.
38+
- **Notes toggle**: hide or show all sticky notes on the canvas.
39+
- **Selection/Pan mode toggle**: switch between selection mode for creating group notes and pan mode for navigation.
3740
- **Test flow**: open the flow [test](../core_concepts/23_instant_preview/index.mdx) slider.
3841
- **Test up to**: open the flow [test](../core_concepts/23_instant_preview/index.mdx) slider.
3942
- **Draft**: save the flow as [draft](../core_concepts/0_draft_and_deploy/index.mdx) (you can do it with shortcut `Ctrl + S` / `⌘ S`).

docs/getting_started/6_flows_quickstart/index.mdx

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -137,6 +137,10 @@ On the left of the editor, you'll find a graphical view of the flow. From there
137137

138138
![Flow editor menu](./flow_editor_menu.png.webp)
139139

140+
:::tip Pro tips
141+
Keep your flows organized and documented with [sticky notes](../../flows/24_sticky_notes.mdx)! Add free notes anywhere on the canvas for comments and TODOs, or create group notes to explain complex workflow sections to your team.
142+
:::
143+
140144
There are four kinds of scripts: [Action](../../flows/3_editor_components.mdx#flow-actions), [Trigger](../../flows/10_flow_trigger.mdx), [Approval](../../flows/11_flow_approval.mdx) and [Error handler](../../flows/7_flow_error_handler.md). You can sequence them how you want. Action is the default script type.
141145

142146
Each script can be called from Workspace or [Hub](https://hub.windmill.dev/), you can also decide to write them inline.
@@ -167,15 +171,15 @@ Your flow can be deepened with [additional features](../../flows/1_flow_editor.m
167171
While loops execute a sequence of code indefinitely until the user cancels or a step set to [Early stop](../../flows/2_early_stop.md) stops.
168172

169173
<video
170-
className="border-2 rounded-xl object-cover w-full h-full dark:border-gray-800"
171-
controls
172-
src="/videos/while_early_stop.mp4"
174+
className="border-2 rounded-xl object-cover w-full h-full dark:border-gray-800"
175+
controls
176+
src="/videos/while_early_stop.mp4"
173177
/>
174178

175-
<br/>
179+
<br />
176180

177181
<div className="grid grid-cols-2 gap-6 mb-4">
178-
<DocCard
182+
<DocCard
179183
color="teal"
180184
title="While loops"
181185
description="While loops execute a sequence of code indefinitely until the user cancels or a step set to Early stop stops."
@@ -310,4 +314,4 @@ Flows are not the only way to write distributed programs that execute distinct j
310314
description="Automate tasks and their flow with only code."
311315
href="/docs/core_concepts/workflows_as_code"
312316
/>
313-
</div>
317+
</div>

sidebars.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -746,7 +746,8 @@ const sidebars = {
746746
'flows/early_return',
747747
'flows/flow_approval',
748748
'flows/sleep',
749-
'flows/step_mocking'
749+
'flows/step_mocking',
750+
'flows/sticky_notes'
750751
],
751752
collapsed: true
752753
},

0 commit comments

Comments
 (0)