← Back to issue list

docs: add release notes index and template

View original Github issue

Metadata

Project
starbase
Number
#286
Type
pull request
State
merged
Author
medubelko
Labels
—
Created
Updated
Closed

Current evaluation

Merged into main as commit dfe2e9a ("docs: add release notes index and template (#286)"), adding docs/release-notes/index.rst with a release notes TOC section and inline release-note template.

Resolution: closed resolved

Reason: PR #286 was approved by three reviewers and merged into main as commit dfe2e9a, creating docs/release-notes/index.rst with the release notes index and an inline per-release template. Reviewer mr-cal confirmed in the final comment that they were happy with what was merged; later commits (#306, #328, #375) continued refining the same file.

Evaluated by: mr-cal-bot

No scores available.

Issue body

Release notes occupy their own top-level section in the documentation TOC. The template for individual release notes is included as a comment at the end of the index. This follows a pattern set by our changelogs. If there's a better way of including copyable templates, please chime in! - [x] Have you followed the guidelines for contributing? - [x] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)? - [x] Have you successfully run `tox`? ----- CRAFT-3712

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved Merged into main as commit dfe2e9a ("docs: add release notes index and template (#286)"), adding docs/release-notes/index.rst with a release notes TOC section and inline release-note template.
stealth/space-bunny-alpha — closed resolved Merged #286 (CRAFT-3712), adding a TOC-linked release notes index and reusable release-note template. Three reviewers approved it, and forward-porting guidance remains optional.
stealth/space-bunny-alpha — closed resolved Merged #286 in commit dfe2e9a, adding a release-notes index to the documentation TOC and an end-of-index template modeled after the changelogs.
qwen/qwen3.6-35b-a3b — — Merged documentation update adding a release notes index to the TOC and a template. Approved by three reviewers, passed CI, and modified six files. Reviewers confirmed the forward-porting section remains optional.
qwen3.6-35b-a3b-mtp-q6 — — Merged documentation update adding a release notes index and template. Reviewers approved keeping the forward-porting section optional. Changes follow existing changelog patterns and address CRAFT-3712.

Update history

No update history recorded yet.

Related work

  • Related To: starbase#306 (confidence 60%)

    Follow-up commit c5c7167 'docs: remove release policy from rn index (#306)' editing the file added by this PR.

  • Related To: starbase#328 (confidence 55%)

    Follow-up commit fbd7c43 'docs: make minor improvements to release note template (#328)' refining the template.

  • Related To: starbase#375 (confidence 55%)

    Follow-up commit f5bcb08 'docs: add patch fixes to release notes template (#375)' refining the template.

Related issues

Issue Project State Summary Similarity
#328 docs: make minor improvements to release note template starbase merged Merged in #328 via commit fbd7c43: clarified that present-tense “now” is acceptable in release notes, added examples, and made fixed-issue entries explicitly links.
74%
#1112 docs(changelog): add template and refs to all releases craft-parts merged Merged #1112 (commits 1bbdaf6c, 61ff44af): added stable release-note reference tags and a reusable changelog template so generated links no longer shift.
73%
#5623 docs: place 'about docs' above 'release notes' in toc snapcraft merged Docs-only PR merged as commit 49749aaa2: reordered docs/index.rst so the "About this documentation" section sits above "Release notes" (kept last), superseding the ordering from #5622.
71%