# Shape notes

## Introduction

You can add notes to any shape in a process flow. This can be useful for many reasons - for example, to keep track of why certain shapes are used in more complex flows; to add reminders for any updates needed in future, or perhaps to leave guidance for another user.

## Need to know

* You can add a single note or multiple notes to each shape - there's no limit
* Any single note cannot exceed 64kb
* Notes are not encrypted - we strongly advise against adding sensitive information such as API keys, login credentials, payload data, etc.&#x20;
* Notes are associated with a shape, not the process flow version, so if you add notes to shapes in a draft process flow and then deploy that process flow, the notes remain in the deployed version.&#x20;

## Accessing shape notes

To access shape notes, click the notes icon for the required shape:

<div align="left"><figure><img src="/files/ty0PJDvqsf3z9CIJPaVI" alt="" width="327"><figcaption></figcaption></figure></div>

Any existing notes for this shape are displayed:

<div align="left"><figure><img src="/files/vhoH9WRoFeVm1s2wLt5s" alt="" width="375"><figcaption></figcaption></figure></div>

From here, you can click any existing note to open it in the [notes editor](#the-notes-editor), or use the **add note** button to [add a new note](#adding-a-new-note).

## Adding a new shape note

To add a new note for a shape, click the shape notes icon for the required shape and then click the add note button:&#x20;

<div align="left"><figure><img src="/files/3pw3F7NBopmgSaieb2JG" alt="" width="375"><figcaption></figcaption></figure></div>

From here you can add required content via the [notes editor](#the-notes-editor), then save your note.

## The notes editor

Notes are added using a markdown editor, which includes a preview pane for rendered output:

<div align="left"><figure><img src="/files/6YOebhvHab1TIYZ59oRQ" alt="" width="563"><figcaption></figcaption></figure></div>

Standard markdown formatting can be used, or you can use the notes editor toolbar to apply formatting and add elements such as code blocks, tables and flow charts.

{% hint style="info" %}
Click [here ](https://www.markdownguide.org/cheat-sheet/)to view a markdown cheat sheet.
{% endhint %}

When adding/editing a note, you can apply a colour - perhaps useful to categorise different types of notes with a visual cue.&#x20;

You can also mark a note as **private** (so only you can see it), or make it available for all users in your organisation. Once a note is saved, the rendered version is displayed in the notes panel.

## Shape note versioning

Notes persist to subsequent versions of a process flow. For example, if you add **two notes** to a `draft` process flow, then deploy that flow, the `deployed` process flow will have **two** **notes**.&#x20;

If you go on to add **one more note** to the current `draft` version and then deploy this draft, the `deployed` process flow will have **three notes**. The `inactive` version will have **two notes**.

{% hint style="info" %}
For more information on process flow versions, see our [Process flow versioning](/product-documentation/process-flows/building-process-flows/process-flow-versioning.md) page.
{% endhint %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://doc.wearepatchworks.com/product-documentation/process-flows/building-process-flows/shape-notes.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
