# 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="https://2440044887-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2FOFCVN3dXuS1xemJ832bl%2Fshape%20notes%201.png?alt=media&#x26;token=b99ec5c8-de1d-424c-b37b-18674dfe92c3" alt="" width="327"><figcaption></figcaption></figure></div>

Any existing notes for this shape are displayed:

<div align="left"><figure><img src="https://2440044887-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2Frq0rEgf36wf7s01U5SbC%2Fshape%20notes%202.png?alt=media&#x26;token=e1408510-b432-480c-9b47-1d1f0273468b" 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="https://2440044887-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2FRhVvmmPTFSLLt7IlMQSD%2Fshape%20notes%203.png?alt=media&#x26;token=b87342b8-eddb-4015-b048-2fa7a3a11d58" 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="https://2440044887-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2FUO8bZnwgSJCIxgFo3MIQ%2Fshape%20notes%204.png?alt=media&#x26;token=35dbdc3e-c8ae-4772-913d-820d8f35c8b3" 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](https://doc.wearepatchworks.com/product-documentation/process-flows/building-process-flows/process-flow-versioning) page.
{% endhint %}
