Callouts
Drawing attention to important information.
Callouts are the workhorse of any docs site. Use them sparingly — when everything is highlighted, nothing is.
Variants
Heads up
Use info for neutral context the reader should know but doesn't have to act on.
Be careful
Use warn when the reader could shoot themselves in the foot. Things like destructive operations, deprecated APIs, and footguns.
This will break things
Use error for things that are actively broken or that will fail. Reserve it for genuine errors — readers tune it out otherwise.
You did it
Use success to confirm a step worked. Pair with Steps to celebrate completing a guide.
Without a title
Titles are optional. Leave them off when the body is a single short sentence and the icon already carries the meaning.
Inside other components
Callouts nest cleanly inside <Steps>, <Tabs>, and <Accordions>.
Banner
<Banner> is the page-wide cousin of <Callout>. Use it sparingly — usually
at the top of a layout to flag a site-wide condition (maintenance, beta status,
a new release).
You're reading the docs for the scaffold. Real release notes will appear here once the site goes live.