avodado
avodado docs
Blocks reference

Narrative & prose

Field contracts and worked examples for the 9 narrative & prose blocks.

Field contracts and worked examples for the narrative & prose blocks — converted at build time from the repo's authoring-skill reference. Every example body is YAML; in a real doc the fence language is the block type (for example sequence … ). Schemas are strict — unknown fields are rejected. See the field contract for the at-a-glance shape of all 77 blocks, or the block catalog for live previews.

Document & meta

meta — document cover (first block only)

```metaeditable · live
renderedavo renders this
Valid — passes avo check

logo is optional — an absolute https URL (or path) shown above the title on the document and slide cover.

Prose & structure

prose — structured prose (heading / paragraph / list / quote)

```proseeditable · live
renderedavo renders this
SECTION 01 · Overview

Background

Why this exists

A short paragraph explaining context.

  • Idea one
  • Idea two
A pull-quote.
Valid — passes avo check

callout — note / tip / warning / danger

```callouteditable · live
renderedavo renders this
SECTION 01 · Note

Idempotency required

Warning
Clients must send an Idempotency-Key header so retries are safe.
Valid — passes avo check

tone is note | tip | warn | danger.

glossary — term / definition rows

```glossaryeditable · live
renderedavo renders this
SECTION 01 · Glossary
Idempotent
A replay produces the same outcome.
SLO
Service-level objective the team commits to.
Valid — passes avo check

figure — an image with a caption

```figureeditable · live
renderedavo renders this
SECTION 01 · Figure
The alerts dashboard after the redesign
The redesigned alerts dashboard: unacked alerts pin to the top.
Valid — passes avo check

src is required (an absolute https URL or a repo-relative path). Use figure for real images — screenshots, photos, exported charts from other tools. For anything the renderer can draw (architecture, flows, data), use a typed diagram block instead so the source stays editable.

faq — Q&A accordions (native details, no JS)

```faqeditable · live
renderedavo renders this
SECTION 01 · FAQ

Rollout questions

Does this change the on-call rotation?

No. Paging stays in PagerDuty; only the alert routing rules move.

What happens to alerts created before the migration?

They keep working — the old webhook stays registered until Q3.

After Q3 the webhook is removed and unmigrated alerts stop firing.

Valid — passes avo check

Each item is one <details> accordion: the question in the summary, the answer expands. open: true starts an item expanded. Answers are plain text — blank lines become paragraph breaks. Use faq for genuine reader questions; use glossary for term definitions and callout for a single aside.

Presentation text

divider — a full-width section break ("PART 2")

```dividereditable · live
renderedavo renders this
SECTION 01 · Divider
PART 2
What we change

The three fixes, in the order we ship them.

Valid — passes avo check

Only title is required. kicker is a short mono eyebrow ("PART 2", "APPENDIX") rendered with rule lines either side; accent tints the kicker and the band's wash (accent as in drivers). In a deck, put a divider alone under its own ## heading and it becomes a clean interstitial slide.

bignumber — one hero metric that carries the slide

```bignumbereditable · live
renderedavo renders this
SECTION 01 · Big number
-75%-1.8s
Checkout p95 after moving capture off the request path

2.4s → 600ms, measured over four weeks of production traffic

Valid — passes avo check

value is a string — quote numeric-looking values ("-75%", "3.2"). trend is up | down | flat; the arrow renders neutral gray on purpose (for a hero metric "down" is often good — latency, cost), while the delta text takes the accent color. Use bignumber for ONE number; use stats for a row of KPIs.

takeaways — the 2-6 things to remember

```takeawayseditable · live
renderedavo renders this
SECTION 01 · Takeaways
Takeaways
  1. The synchronous capture call was the bottleneck

    It accounted for 71% of the 2.4s checkout p95.

  2. Moving it to a queue cut p95 by 75%
  3. Conversion recovered within two weeks

    +0.4pp against the pre-regression baseline.

Valid — passes avo check

items takes 2-6 rows; each text is a bold one-liner, detail an optional smaller line beneath. title defaults to "Takeaways"; accent tints the circled numbers. The natural closing slide of a deck — use list for ordinary bullets inside a document.