Skip to content

Info hints

hint attaches a (?) badge to a node or edge. Hovering shows a markdown preview; clicking opens a new window. Hints keep diagrams clean while linking to the detail behind a box.

The value is a markdown link — a quoted destination is inline markdown, a path links a file:

hint api: [Rate limit]("Token bucket, **5 req/min**, refilled per second.")
hint api: [Runbook](../runbooks/rate-limiting.md) # a .md file, rendered as markdown
hint api->db: [Schema](db.vizzy.md) # a .vizzy.md, opened as a diagram
  • Quoted destination → inline markdown, shown in the hover preview and the window.
  • A path → a file. .md is rendered as markdown; .vizzy.md is opened as a diagram. Paths resolve relative to the document’s folder.

The subject is a node id, or an edge written compactly as A->B (same as the payload directive). Two hints on the same subject merge — the inline one becomes the hover preview, the file one becomes the click target.

Use the eye button in the app’s toolbar to show or hide all hint badges at once.