Resource → Notes
Notes provide a small Markdown runbook for each resource or location. Use them for installation context, vendor cases, on-call hand-offs, planned work, or anything that does not belong in structured inventory fields.
The same Notes tab is available on resource and location detail pages. Each scope has its own content, version history, edit lock, and attachments.
Note content
- The editor stores Markdown and shows a sanitized preview.
- Inline images are not rendered. Add files through the attachment button so viewing a note never contacts an external image host.
- Every save creates an immutable version.
- The History menu opens a previous version read-only. Historical versions can be deleted; the current version cannot.
- Only one operator can edit a note at a time. The presence banner identifies the current editor, and abandoned locks expire automatically. Shortly before your own edit lock expires, a banner counts down — “Auto-release in N seconds” — with an Extend button to keep it.
- If another operator publishes a newer version while you are reading, the tab offers to reload it.
The toolbar includes headings, bold, italic, strikethrough, quotes, bulleted, numbered and task lists, links, tables, inline code, fenced code blocks, horizontal rules, and undo/redo. A live preview is always shown alongside what you type.
The editor, live preview, and saved note follow the application’s light or dark theme, including code-block backgrounds. Switching themes updates their appearance without saving the note. Previewing an edit does not publish it; click Save to create a new version.
Fenced code blocks support syntax highlighting in both saved notes and the live
preview. Specify a language after the opening triple backticks, such as python,
bash, powershell, json, or sql. Highlighting works without internet access
and its colors follow the selected theme.
Attachments
Attachments belong to the resource or location, independently of note versions. They appear in the attachment bar at the bottom of the tab; upload them with the paper-clip button in the toolbar, without opening the note editor. Click an attachment to download it. Deleting an attachment is explicit and permanent; saving or deleting a note version never changes attachments.
Supported files:
| Class | Types | Maximum size |
|---|---|---|
| Images | PNG, JPEG, GIF, WebP | 10 MiB |
| Documents | 10 MiB | |
| Text | TXT, LOG, CSV, JSON, Markdown, XML | 1 MiB |
Files are downloaded rather than rendered inline. MisterShell validates their extension, content, and size before storing them.
Visible to AI
AI tools read the latest stored Markdown directly; historical versions are not included. They can see the attachment count, but attachment contents are not automatically added to AI context in this release.
Common tasks
Record operational context
- Click Edit.
- Write the runbook or hand-off in Markdown. Use fenced code blocks for commands and output.
- Click Save. Save again whenever you want a new history point.
Inspect an earlier version
- Open History.
- Select the version to read.
- Choose Back to latest when finished.
Permissions
- Read notes and attachment metadata/downloads:
app.notes.read, plus access to the resource or location. - Edit notes and upload attachments:
app.notes.write, plus write access to the resource or location. - Delete historical versions or attachments:
app.notes.delete, plus write access to the resource or location.