Skip to main content

Release Notes Template

Release notes are heartbeat updates. They tell readers what shipped, what needs attention, and where to go for the deep dive fast.

❌ DO NOT COPY: Guidance & Constraints

  • Frontmatter must include title, description, icon, releaseDate, and version. Add tags if you need filters (e.g., ["platform", "oss"]).
  • Lead with a one-sentence headline plus a quick stats table (New features, Fixes, Required action). Keep the TL;DR in an <Info> block; use <Warning> only for breaking changes or deadlines.
  • Organize the body into Highlights, Improvements & fixes (grouped by product), and Known issues. Each bullet links to docs where appropriate.
  • When reshaping older release notes, retain the shipped items and shout-outs. Map them to these sections instead of rewriting history.
  • Include an Upgrade checklist with concrete next steps. Optional “Community shout-outs” should remain short.
  • Two-card CTA at the end, as always: left = deeper reference, right = applied next step.

✅ COPY THIS: Content Skeleton

Paste the snippet below, swap placeholders, and trim optional sections only once you know they’re unnecessary.

✅ Publish Checklist

  • Headline sentence and stats table reflect the release accurately.
  • Every highlight, improvement, and issue links to supporting docs when available.
  • <Warning> only appears when a deadline or breaking change exists.
  • Upgrade checklist lists concrete steps (not vague reminders).
  • Exactly two CTA cards at the end with valid links.

Browse Other Templates

Quickstart

Operation Guide

Feature Guide

Concept Guide

Integration Guide

Cookbook

API Reference

Parameters Reference

Migration Guide

Release Notes

Troubleshooting Playbook

Section Overview

Contribution Hub

Docs Home