Your first diagram
Author, validate, preview, and build a topology from scratch — the loop you will repeat forever.
This walks the whole loop once with a real, working topology. The point is less the example than the rhythm: author → validate → look → build, never skipping the middle two.
Find your icons first
Never invent an icon ID. A wrong one is a validation error, and guessing wastes a round trip:
IDs look like <pack>/<category>/<name>. This example uses the affinity pack
because it ships with the repo and needs no fetch.
Write the YAML
Create input/branch.yaml:
Notice what's being declared: two zones, a tier on every device, a hero, and one degraded link. Nothing about position.
Validate — every time
Zero errors, or it isn't ready. Warnings are advisory (an unlinked device, an empty zone, a port used twice) — usually worth fixing, never blocking.
When something is wrong you get the line, a snippet, and a suggestion:
Fix what it tells you rather than guessing. The full list is in Diagnostic codes.
Look at it
Two ways. A live server that reloads as you save:
Or a still image, which is what you want when an agent is driving:
Then actually open it. Layout problems, unreadable labels, and a story that
doesn't land are all invisible to validate and obvious in a picture.
Build
One file. Double-click it, mail it, commit it to a wiki. It works with the network cable unplugged.
What you got
The built file is not a picture — it's an application:
| Interaction | What it does |
|---|---|
| Drag / scroll | Pan and zoom the stage |
| Click a device | Inspector: role, mgmt IP, interfaces, notes, config |
| Hover a device | Dims everything but its neighborhood |
| Click a link | Kind, speed, LAG, status, notes |
| ⌘:kbdK | Command palette — search, view settings, export |
| ⌘:kbdB | Sidebar |
| Export | PNG or SVG, from the sidebar menu |
The status: degraded you set on srv-01 shows as an amber LED on the device
and a dashed amber link. Status is declared, not polled — see
Authoring.
Next
- Live preview — the fast edit loop.
- Zones & tiers — the two keys that shape everything.
- How layout is chosen — why your diagram looks the way it does.