Docs / Editing docs

Editing docs

Select a doc in the Library to open it. The editor has three view modes, switchable from the toggle in the editor bar:

  • Preview — rendered markdown, fully formatted and readable.
  • Split — source on the left, live preview on the right.
  • Source — raw markdown editor only.

Saving

Edits autosave about one second after you stop typing. Press ⌘S to save explicitly and take an immediate version snapshot. The indicator in the frontmatter strip shows an amber dot for unsaved changes and a coloured dot for saved. See Version history for how snapshots work.

The frontmatter strip

Above the document body is a frontmatter strip — controls for the doc’s metadata:

Control What it does
Type dropdown Change doc type — written back to frontmatter immediately
Status pill Shows draft, active, or review
Release dropdown Link the doc to a specific release version
Tags Comma-separated tags from tags: in frontmatter

Frontmatter reference

YAML frontmatter goes between --- fences at the very top of the file:

---
title: Backend architecture
type: arch
status: active
tags: [backend, database, v2]
release: 1.0.0
pinned: true
---
Field Values Default
title Free text Filename without extension
type rules · plans · arch · adr · notes · responses notes
status draft · active · review draft
tags Array of strings []
release Version string (e.g. 1.0.0) none
pinned true / false false

You can edit frontmatter directly in source mode or use the strip controls — both paths write the same result to the file.

Auto-pairing and shortcuts

The source editor pairs brackets and quotes as you type:

  • Type [[] with the cursor inside; type [ again → [[]] for a wikilink.
  • (, {, ", ', and ` pair the same way.
  • Select text and press a bracket/quote to wrap the selection.
  • Backspace on an empty pair removes both characters.

Type [[ and start a document name — a suggestion dropdown appears with matching docs. Use arrow keys to navigate, then press Enter or Tab to insert the link. The closing ]] is already there.

Example: type [[arch → the dropdown suggests [[architecture]], [[arch-decisions]], etc. See Links, backlinks, and graph for how links resolve.

Editor appearance

Adjust the source editor in Settings → Appearance (⌘,):

  • Editor font — JetBrains Mono (bundled), SF Mono, Menlo, Fira Code, Cascadia Code, and others, or type any font name installed on your machine.
  • Editor font size — 11–24 px; use A− / A+ buttons, or reset to default.
  • Editor line height — Tight (1.4), Cozy (1.6), Default (1.75), Relaxed (2.0).

Get release notes

An email when a new build ships or a major feature lands. A few times a quarter — never your inbox sold.

You're on the list — watch for a confirmation email.