Agent API DocsRelease Post Example
A practical advanced layout pattern for release posts: tell readers why the update matters first, then organize the changes and the next action.
Release Post Example
Release posts often fail in one of two ways:
- they open with a feature dump
- or they open with emotion and very little information
A steadier structure is to explain why the update matters first, then organize the changes, then land the next action.
A strong module set for this job
herocardscompareorstepssummarycta
A skeleton you can adapt directly
:::hero
eyebrow: Release
title: This update matters less because it adds more, and more because it makes the main path smoother
subtitle: Start with the changes that will affect daily use first
:::
:::cards[What this update covers]
Install | Easier entry | Fewer steps before first use | accent
Layout | Stronger structure | The point appears earlier | default
Images | Better defaults | Less wasted trial and error | default
:::
:::compare[Before and after]
Install | You had to find the right entry yourself | The recommended path is clear from the start | accent
Layout | Mostly solved whether content could render | Now it also helps content get read to the end | default
Images | Defaults were often mismatched | Defaults now follow the current provider better | default
:::
:::summary
title: If you remember one thing
body: The real gain is not one more feature. The real gain is that the previously separate steps now connect more cleanly.
:::
:::cta
title: What to try next
body: Run preview once on a real article first. Then decide whether this belongs in your long-term workflow.
button_text: Read quickstart
button_url: /docs/quickstart
:::What to avoid
- do not list every change on the first screen
- do not blend what changed with why it matters into one muddy paragraph
- do not end with a vague “try it now” without a next step