AppSurface Search
Guide

Tagged release template

Consumer-led template for future versioned AppSurface release notes.

Source of truth

View source Edit this page

Last updated

Replace every placeholder in this template before publishing a tagged AppSurface release note.

Why this release matters

Write the short story first. Explain what adopters can do now, who should care, which packages or app shapes are affected, and why the change matters. Avoid opening with internal feature labels unless the surrounding sentence already explains the consumer outcome.

Highlights

  • Consumer outcome one, with the affected package and start-here link.
  • Consumer outcome two, with the affected package and start-here link.
  • Consumer outcome three, with the affected package and start-here link.

Start Here

  • Package chooser or package README:
  • Guide:
  • Example:
  • CLI or verification command:

What shipped

Packages and APIs

  • Describe package-level changes here. Lead with the reader-facing behavior before naming internal abstractions, and link named packages, cross-package concepts, and companion guides on first meaningful mention.

CLI and tooling

  • Describe CLI and developer workflow changes here. Include the command a consumer should run when the release adds a verifier, migration helper, or proof workflow, and link the command reference or guide.

Docs and examples

  • Describe docs-facing and example changes here. Link guides and examples beside the feature they explain, and connect adjacent concepts readers are likely to need next.

Boundaries and pitfalls

  • State what this release does not own, what stays host-owned, and which ordering or configuration mistakes adopters should avoid.

Migration guidance

  • List the concrete upgrade steps here.
  • Link back to the compact summary in CHANGELOG.md.
  • Changelog entry: ../CHANGELOG.md
  • Previous release note: add link if one exists