← Back to issue list

docs: place 'about docs' above 'release notes' in toc

View original Github issue

Metadata

Project
snapcraft
Number
#5623
Type
pull request
State
merged
Author
medubelko
Labels
—
Created
Updated
Closed

Current evaluation

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.

Resolution: closed resolved

Reason: The PR itself was merged into main as commit 49749aaa2 ("docs: place 'about docs' above 'release notes' in toc"), a one-line change in docs/index.rst approved by two reviewers. It fixes the TOC ordering introduced by the earlier merged PR #5622 (commit 258251541).

Evaluated by: mr-cal-bot

No scores available.

Issue body

We had a change of heart about the position of the page in the TOC. We want release notes to always be the final item. --- - [x] Have you followed the [guidelines for contributing](https://github.com/canonical/snapcraft/blob/main/CONTRIBUTING.md)? - [x] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)? - [ ] Have you successfully run `make lint`? - [ ] Have you successfully run `make test`? ---

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved 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.
stealth/space-bunny-alpha — closed resolved Merged in commit 49749aaa2: moved About docs above Release notes in the documentation TOC, keeping Release notes last.
qwen/qwen3.6-35b-a3b — — Merged a documentation update reordering the table of contents to place 'about docs' above 'release notes', ensuring release notes remain the final item. Approved by two reviewers and merged with a single line change.
qwen3.6-35b-a3b-mtp-q6 — — Merged documentation update reordering the table of contents to place 'about docs' above 'release notes', ensuring release notes remain the final item. Integrated by maintainer medubelko.

Update history

No update history recorded yet.

Related work

  • Related To: canonical/snapcraft#5622 (confidence 90%)

    PR #5622 (commit 258251541) added the 'About this documentation' section whose position #5623 corrected; later renames (#5656) and homepage rewrites (#6000) further reshuffled the same page.

Related issues

Issue Project State Summary Similarity
#286 docs: add release notes index and template starbase merged 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.
71%