Documents and pages
One document view for every push, the reader's own settings, audiences, exports to PDF, HTML, Email and Word, comments in the margin, and pages written together live.
Two kinds of writing
| Card | What it is |
|---|---|
| Page | A document written in place on the board with a block editor, by several people at once. Agents read and write the same page as markdown. A page pushed from a file in your repository refreshes whenever that file is pushed again. |
| Document | Composed from elements — prose, tables, charts, diagrams, galleries, callouts, code — by an agent or a push, and read in the document view below. On the board, ✎ opens its elements as JSON; for prose you write yourself, use a page. |
What an author can put in a document, and how to push one, is in authoring and the elements reference.
Writing together
Open a page — double-click it, or ✎ edit the page in the selection bar, or ⌘E — and write. Everyone editing the page sees each other's cursor and every change as it is typed; there is no save and no lock. Through a share link a page is read-only.
One document view
Every pushed document — a composed document, an index.html, a folder of files — opens as one view at its own address, and a document card on a board opens there too (open in its selection bar). A pushed set of screenshots opens as its journey board instead.
- The outline — a rail at the side lists the document's chapters and the documents linked around it; a click glides to the place. Fold it away and it stays folded on this device.
- Links — every section carries an anchor, authored or derived from its title, so a link can land on a section and the view opens there. Documents reference each other, and table cells can link to the proof behind a claim.
- A pushed web page — its head carries Appearance (the look alone), Share and Comment from the bar below, plus ⤓ to download the pushed files as a zip.
- Delete — the trash icon at the end of the head (members, never viewers or link guests) deletes the document after you confirm. A pushed artifact goes whole: its pages, its place in Docs › Artifacts and its files. Undo brings it back on the spot; later, its address shows who deleted it and when, with Restore, for 30 days — then it is purged. A push of the same artifact is refused while it is deleted; restore it, or push with
--revive(sets).
The viewer bar
A composed document carries a row of menus in its head.
| Menu | What it sets |
|---|---|
| Appearance | The look, then the text. The look: House (your app theme), Light paper or Dark paper (the house look pinned light or dark, whatever your app theme), or one of the board styles — the document's own board style is marked default. The text: size, line spacing, line length, the font (House or Hyperlegible), wider text spacing (WCAG 1.4.12), focus letters, and reader mode — just the text, no outline and no comments. Reset all returns both. Kept on this device only; the document itself never changes. |
| Audience | Shown when the author tagged blocks for a readership: Everyone, Public, Technical or Internal. Picking one hides the blocks written for the others. |
| Export | PDF, HTML, Email or Word — below. |
| Share | A link that opens on this document — sharing. |
| Comment | A comment on the document — below. |
| Delete | Deletes the document — or a pushed artifact, whole — to the trash for 30 days; Undo or its page's Restore brings it back. Members only. |
Export
- PDF — print-ready pages. On a deployment without a PDF service the browser's print dialog opens instead; choose Save as PDF.
- HTML — one self-contained page, made in your browser from what you see.
- Email — an
.emldraft with the images inline, ready to open in a mail client. - Word — an editable
.docx.
Every export keeps the audience you picked. PDF, Email and Word are produced by the server and recorded in the audit log as your export. Scripts fetch the same files from GET /api/v1/boards/{slug}/cards/{id}.pdf (or .eml, .docx), with ?audience= to narrow them.
Comments
Select a passage and comment on it, or ▭ pin a region of a pushed page. The thread opens in the margin rail beside its passage and stays there as the page reflows. At rest a card only reads — who, when, the quoted words, the comment and its replies; click into it for ✓ resolve and the reply field. Threads whose passages scrolled out of view gather into a pill at the rail's top or foot — ↑ 3 comments, ↓ 2 comments — and each click on it scrolls to the nearest one and focuses its card. A comment is an annotation on the document's card, so it follows the same staging and reaches the same agent queue as a region drawn on a board — annotating. A guest on an annotate link comments too; their comments wait for a member of the workspace.
Sharing a document
Share in the viewer bar mints a link that opens straight on this document. It still grants the whole board the document sits on — sharing with people outside.