Docs
Documents
Open a markdown file as a live tile beside the work — rendered, editable, and readable back by the session that wrote it.
A tile doesn’t have to be a terminal. dispatch_doc opens a markdown file as a tile in the
grid beside the terminals: the file opens in an editor next to the session that produced it,
rendered rather than raw, and you can edit it there.
This is how a plan an agent has just written actually gets read — instead of being pasted into a terminal in full.
Live in both directions
The file changes, the tile reloads. Rewrite the file with any tool and the tile reloads by itself — as long as nothing is unsaved, which is when it asks you instead of choosing.
The tile changes, the session can read it. dispatch_read on a document tile returns what
is on screen including edits not yet saved, which is the one thing reading the file from
disk cannot tell you. So a lead session can write a plan, you can amend it in the tile, and the
session can read your amendments back before acting on them.
Opening one
Only .md, .markdown and .mdx can be opened, and the file must already exist — write it
first.
| Argument | Does |
|---|---|
path |
The markdown file: absolute, or relative to project. |
project |
Which project a relative path is relative to — a name as returned by dispatch_projects, or an absolute path. |
tile |
An existing document tile to point at this file instead of opening another one. |
title |
Optional name for the tile. Defaults to the file name. |
workspace |
Which workspace to open it in. Defaults to the one on screen, which is almost always right — the point is to put the document next to the work. |
Without tile, a document already open in the workspace is brought forward rather than
duplicated.
In a plan
A tile in a dispatch_plan call can carry a doc instead of a prompt, so a planned workspace
comes up with its plan already open beside the work it describes — the terminals armed on the
left, the document explaining them on the right.