Annotate Your Workspace with Notes
Use the built-in Markdown Notes panel to document your data, record findings, and keep context alongside your JSON workspace.
Last updated:
Data analysis is only useful if you can remember — and share — what you found. The Workspace Notes panel gives you a full Markdown editor embedded right next to your data, so your documentation never gets separated from your work.
🚩 The Scenario
You've loaded a large API response, identified some anomalies, written transform scripts, and now need to:
- Document what the fields mean.
- Record your findings for a colleague.
- Note which transform steps you applied and why.
🛠️ Step-by-Step
- Open or create a workspace in the Home page.
- In the workspace carousel, navigate to the Notes tab.
- Start writing in the Markdown editor (powered by Monaco — the same engine as VS Code).
✍️ Markdown Features
The Notes panel supports full Markdown syntax:
# Dataset: User Activity Logs
## Data Source
- API: `GET /api/v2/activity?from=2025-01-01`
- Fetched: 2025-04-23
- Records: 12,450
## Key Findings
1. **23% of users** have `null` for `lastLoginDate` — likely pre-migration accounts.
2. The `eventType` field has 3 undocumented values: `LEGACY_A`, `LEGACY_B`, `UNKNOWN`.
3. All records with `status: "inactive"` have `score: 0`.
## Transform Applied
Renamed `uid` → `userId`, dropped `internalRef` field.
📊 Productivity Features
- Live Preview: Toggle between Edit and Preview modes to see rendered Markdown.
- Word & Character Count: Displayed at the bottom of the panel for reference.
- Copy to Clipboard: One-click copy of all notes content.
- Download as
.md: Export your notes as a Markdown file for documentation repos or wikis.
💾 Auto-Save
Notes are automatically saved to your workspace as you type. There's no Save button to forget — every keystroke is persisted. When you open the workspace again, your notes are exactly where you left them.
🔗 Combining Notes with Other Tools
Notes work best when used alongside other workspace tools:
| Workflow | How to Use Notes |
|---|---|
| Data cleaning | Document which fields you dropped and why |
| Transform Builder | Record the business logic behind each mapping |
| Schema Generator | Annotate which fields are optional vs required |
| Comparator | Note what changed between the two JSON versions |
| Sharing | Write a summary so recipients understand the data |
💡 Tips
- Use
## TODOsections to track pending work within a workspace. - Paste in code blocks with triple backticks to document JSONPath queries or jq expressions.
- Use the download button to turn your notes into a
README.mdfor any exported dataset.
🚀 Try it now
Open a workspace in the Editor and click the Notes tab in the carousel to start documenting your data.