Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions docs/docs/workflows/steps/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,4 +67,30 @@ For examples of supported data types in your steps language, see the examples be
* [Bash](/code/bash/#sharing-data-between-steps)
* [Go](/code/go/#sharing-data-between-steps)

## Step Notes

Pipedream lets you add notes to individual steps in your workflow so you can include helpful context to other workspace members or even yourself, and you can even write markdown!

![Viewing step notes](https://res.cloudinary.com/pipedreamin/image/upload/v1698167274/view_notes_zto8bp.png)

### Adding or editing a note
1. Enter build mode on any workflow
2. Click into the overflow menu (3 dots) at the top right of any step
3. Select **Add note** (or **Edit note** if making changes to an existing note)
4. Add any text or markdown, then click **Update**

![Add note](https://res.cloudinary.com/pipedreamin/image/upload/v1698167274/add_note_kvvxju.png)

![Adding step notes](https://res.cloudinary.com/pipedreamin/image/upload/v1698167274/add_note_zg62i2.gif)

### Showing notes
1. Any step that has a note will indicate this with a special icon (shown below)
2. Click on the icon to hide or show the note

![View notes](https://res.cloudinary.com/pipedreamin/image/upload/v1698167274/view_note_p5uvkg.gif)

### Current limitations
- Step notes are not currently included when copying or [sharing](/workflows/sharing) a workflow
- Step notes are only accessible in Edit mode, and not from the Inspector

<Footer />