What it is
Writing top-down means calling documents before they exist: .do Verify identity today, write “Verify identity” tomorrow. Runic keeps the gap visible without nagging. The line is marked, the sidebar shows a dot, and the fix is one click.
How it works
The reference index checks every .go and .do target against the names of every document, processes and sequence diagrams, case-insensitive and trimmed, ignoring any arrow caption. Targets with no definition are collected per document.
In a process, a broken line gets a pale amber background and, pinned at its right edge, a chip reading “+ Create as process” whose tooltip says “No document is named “Verify identity” — create it as a process now”. Clicking it creates an empty process with exactly the target name — the caption, if any, stripped — and switches to it; if a document with that name appeared in the meantime, the click opens it instead. The new document is always a process, even when the caller is a sequence diagram.
The sidebar shows a 7-pixel amber dot on any document with broken references; the tooltip reads “N broken references (.go/.do target missing)”. It clears the moment the last target exists: created, renamed to match, or typo fixed. Clicking a Go or Do card in the diagram runs the same jump, so a missing target can be created from the picture too. In a sequence diagram the REF or GO TO box is tinted amber with a “+ Create” label and the tooltip “No document is named “X” — click to create it”, and the click creates a process.
Why it matters
The gap in your documentation becomes the next thing you write. The missing documents are marked in place, counted per document, and turned into real documents with one click, instead of a TODO list kept somewhere else.
Limits
A broken reference is not a parse error: the line still renders as a card and the sync chip stays “In sync”. The chip is hidden in the folded view. With billing configured, creating counts against the free plan’s 10 processes; past that the upgrade dialog opens and nothing changes.
Keep captions off .go lines. The parser keeps everything after .go as the card’s name, so .go Ship: next day draws a Go card reading “Ship: next day” and clicking that card opens or creates a document with that whole name, while the reference index and the chip resolve the same line as a call to “Ship”. .do lines split the caption properly.
How to use it
- Write the call firstType
.do Verify identityeven though no such document exists. The line renders as a Do card and gets an amber band in the editor. - Read the chipAt the end of the line a chip reads “+ Create as process”. Hover it: “No document is named “Verify identity” — create it as a process now”.
- Click itRunic creates an empty process named “Verify identity”, adds it to the sidebar, and switches the editor to it.
- Write the processDescribe its steps. Switch back to the caller: the amber band is gone and the sidebar dot has cleared.
- Or fix the nameIf the target was a typo, retype it or pick the right document from the .do menu. The marker clears as soon as the names match.
Commands & shortcuts
| + Create as process | Inline chip on a broken .go/.do line in a process |
| Amber band | Editor background on a line whose target is missing |
| Amber dot | Sidebar marker: “N broken references (.go/.do target missing)” |
| Click a Go / Do card | Opens the target, creating it as a process when missing |
| Amber REF / GO TO box | Sequence pane, labelled “+ Create”: “No document is named “X” — click to create it” |
Tips
- Draft the main flow with .do calls to documents that do not exist yet, then walk the amber chips top to bottom to write each one.
- Matching is case-insensitive, so “verify identity” and “Verify Identity” resolve to the same document.
- The chip ignores captions:
.do Verify identity: same dayis checked against “Verify identity” and creates “Verify identity”. - After a rename, glance at the sidebar dots to catch any call site in a view-only document that was not rewritten.
Questions
Why is the broken line not pink?
Pink marks a line the parser cannot place. A missing target parses fine; it is a workspace-level gap, so it gets amber and a fix instead of an error.
What name does the new document get?
Exactly the text after .go or .do, trimmed, with any “: caption” removed. It is created as a process. Rename it later from the top bar and the call site follows.
Can the chip create a sequence diagram?
No. The quick fix always creates a process. Create the diagram from the sidebar’s + menu with the same name and the reference resolves to it.
Can I create it without leaving the current document?
Not from the chip; it opens the new document so you can write it. Pick the caller in the sidebar to come back, or click the new document’s reference badge and choose the call site.