Sticky Note node

Sticky Note Node

Overview

The Sticky Note Node is an informational element you can drop onto the pipeline canvas to leave rich, Markdown-supported documentation. It never runs, has no ports, and exists purely to communicate intent, instructions, or troubleshooting tips to collaborators. Treat it as an in-line knowledge base that travels with the pipeline definition.

---

Core Functionality

1. Markdown Content

• Author notes using GitHub-flavoured Markdown—headings, emphasis, code blocks, lists, links, and more.
• Markdown renders directly on the canvas with a themed “sticky note” style.
• Store Markdown inside parameters.content; documentation settings remain separate for system metadata.

2. Color Themes

• Built-in palettes (yellow, blue, green, pink, purple, etc.) help classify notes (warnings vs. reminders).
• Both light and dark UI themes are supported with consistent foreground/background contrast.

3. Resizable Canvas Element

• Configure width and height numerically or drag the note’s resize handles when selected.
• Dimensions persist with the pipeline definition so every viewer sees the same layout.

4. Zero Execution Footprint

• No input or output ports; the node never participates in runtime execution.
• Pipelines validate and deploy regardless of sticky notes—executors ignore them.

---

Configuration Reference

Content Editor

Content Configuration

Settings Tab

Settings Configuration

Content

Field	Type	Default	Description
Note Content	string	"Add your note here"	Markdown text rendered inside the sticky note.
Color	string	"yellow"	Theme name (yellow, blue, green, pink, purple, orange, red, gray, white).

Settings

Field	Type	Default	Description
Notes	string	""	Out-of-band documentation (author info, ticket links).
Display Note in Pipeline	boolean	false	Show documentation notes within the canvas tooltip.
Width	number	350	Width in pixels; validated to be positive (UI enforces ~120–800).
Height	number	300	Height in pixels; validated to be positive (UI enforces ~80–600).

---

Usage Examples

Example 1: QA Checklist Reminder

Field	Value
Content	"### QA Checklist\n- [ ] Update staging webhook\n- [ ] Regenerate API tokens\n- [ ] Notify release channel"
Color	yellow
Width	380
Height	220
Notes	Owned by Team Mercury

Place this note beside QA-related branches so everyone follows the same release checklist.

Example 2: Highlight Pending Connector Swap

Field	Value
Content	"**TODO:** Replace the mock HTTP call with the production connector once credentials arrive."
Color	pink
Width	420
Height	180

Use a bright color to flag action items that must be resolved before go-live.

Example 3: Document Shift Handoff

Field	Value
Content	"**Shift Notes (Night):** Review torque anomalies logged at 02:15. See ticket OPS-482."
Color	blue
Width	360
Height	200
Display Note in Pipeline	true

The visible content guides on-call staff, while the display option shows supplementary metadata directly on the canvas tooltip.