Skip to content

Note Block

The Note block adds documentation and comments directly on the canvas. It's purely for annotation purposes and has no effect on workflow execution or deployment.

AWS Service: None (documentation only)


Markdown Support

The Note block supports standard Markdown syntax:

Headers

# Heading 1
## Heading 2
### Heading 3

Text Formatting

**bold text**
*italic text*
~~strikethrough~~
`inline code`

Lists

- Bullet point 1
- Bullet point 2
  - Nested item

1. Numbered item
2. Another item
[Link text](https://example.com)

Code Blocks

```javascript
const hello = "world";
```

Use Cases

Workflow Documentation

Add context about what the workflow does:

# User Registration Flow

This workflow handles new user signups:
1. Validates input data
2. Creates user in database
3. Sends welcome email

Team Communication

Leave notes for team members:

## TODO
- [ ] Add rate limiting
- [ ] Implement caching

**Owner**: @john
**Due**: Sprint 15

API Documentation

Document API endpoints:

## GET /users/{id}

**Parameters:**
- `id` (path): User ID

**Response:**
- `200`: User object
- `404`: User not found

Architecture Notes

Explain design decisions:

## Why Queue?

Using SQS here to:
- Handle traffic spikes
- Ensure message delivery
- Decouple services

Best Practices

  1. Keep notes concise: Brief, scannable content works best
  2. Use colors meaningfully: Consistent color coding helps navigation
  3. Position strategically: Place notes near relevant blocks
  4. Update regularly: Keep documentation current with workflow changes
  5. Use headers: Structure longer notes with clear headings