Changelog
/authoring/changelog
PreviewScribe previewscribe
The secondary navigation calls it Release notes — "Reviewed release narrative over the
classified changelog". For each published revision of a project the main app classifies the
contract changes deterministically; this surface lets you write the release note over them, route it
through review, and emit it as CHANGELOG.md and a feed. It is project-scoped: "Choose a project to
review its release history. Each published revision carries its classified changelog and the
narrative written over it."
The tabs
| Tab | What it shows |
|---|---|
| Releases | Published revisions with their severity — Docs only, Non-breaking, Breaking — and a No note yet badge |
| Changes | The classified changes of the selected release: Pending, Classification failed, First publication or Classified |
| Narrative | The note itself |
| Workflow | Draft, review, approval and publication, with the audit trail |
| Outputs | CHANGELOG.md, feeds and stable release-page links |
Write the narrative
- On Releases, pick a revision; on Narrative, Start the release note.
- Fill Title, Audience (Internal, Partners, Public), Executive summary, Semantic version and the Compare link.
- Ask the model for cited narrative — proposals grounded in the classified changes appear under AI proposals awaiting review (N) with Accept and Reject. With nothing classified: "There are no classified changes to ground a proposal in…"
- Add a manual entry for what the contract diff cannot see — Highlight, Deprecation, Upgrade note, Migration or Operational, with an optional Citation key — then Add entry. Empty: "No entries yet. Manual entries record what the contract diff cannot see."
- Save release note (Saving…, then Saved). Entries stay local until the note is saved; a note changed elsewhere since you loaded it is refused: "Someone else changed this note since you loaded it…"
Workflow
Submit for review → Approve → Publish narrative, with Return to draft at any point: the states are Draft, In review, Approved and Published, each recorded in the Audit trail. Unsaved edits must be saved before a transition.
Outputs
Stable links — the release page, its breaking-changes anchor and the compare view. Export preview toggles between CHANGELOG.md and JSON feed, with Copy. Before approval: "There is no release note yet. Approve a narrative to emit CHANGELOG.md, feeds…"
The project's classified changes themselves — and the version change reports the main app produces — are documented at Compare published versions. This surface never alters them: "Classified changes publish on their own authority…"
With no published revisions: "This project has no published revisions yet. Publish a version and its classified changelog will appear here…" When no backend answers, the page shows a worked example and says so.