Skip to main content

Tab kinds

Tab kinds

Every tab in a stratum has a kind, chosen when you add it. One stratum can mix them freely.

Rich

Markdown, with images and embedded diagrams. The default. Use it for explanation.

It is the same editor used for a blueprint's Rich Text tabs and for folium pages, so the whole component library is available: callouts, steps, tables, accordions.

Raw

Plain text rendered as a line-numbered block with syntax highlighting.

Use it for the thing itself: a config file, a command, a schema, a log excerpt. Prose that happens to be short belongs in Rich.

Subdiagram

A diagram of its own, drawn in Vellum, draw.io, Excalidraw or Mermaid.

A box labelled "Payments" on a context diagram can hold the payments service's own component diagram, and that diagram's shapes can carry their own strata.

Image

A single image, uploaded or referenced by URL.

Embed

An embeddable URL. YouTube and Google Maps links are converted to their embed form automatically. Other URLs are accepted with a warning, because not every site permits framing.

Choosing

You haveUse
An explanationRich
A file, command or schemaRaw
Another diagram's worth of detailSubdiagram
A photo, screenshot or rendered chartImage
A video, map or dashboardEmbed

A Subdiagram tab's shapes can carry strata of their own. There is no depth limit, but past three levels the thing you are drawing is usually better as its own blueprint.