docs: improve sidebar for the changelog page
Metadata
Current evaluation
Merged docs PR: added `:tocdepth: 2` to docs/release-notes/changelog.rst so Sphinx renders a per-release table of contents in the sidebar, making long changelog sections easier to navigate.
Resolution: closed resolved
Reason: PR #5070 was approved by 3 reviewers and merged as commit 1b6b0cb42; the two-line change adds a `:tocdepth: 2` directive to docs/release-notes/changelog.rst, which is still present at the current HEAD. mr-cal noted the spread test failure was a Launchpad connectivity issue, not related to the change.
Evaluated by: mr-cal-bot
No scores available.
Issue body
These two facts:
- Changelog entries for a given version can be rather long
- We order the versions "chronologically" instead of "numerically"
... mean that the entries for a given major version can get "hidden" further
down the page if multiple hotfixes have been released in the meantime. This
can cause confusion and make it seem like the version has not been released,
or at least doesn't have changelog entries. To alleviate this, add a table of
contents to the sidebar that links to the subsection for each release.
- [ ] Have you followed the [guidelines for contributing](https://github.com/canonical/snapcraft/blob/main/CONTRIBUTING.md)?
- [ ] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)?
- [ ] Have you successfully run `tox run -m lint`?
- [ ] Have you successfully run `tox run -e test-py310`? (supported versions: `py39`, `py310`, `py311`, `py312`)
-----
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Merged docs PR: added `:tocdepth: 2` to docs/release-notes/changelog.rst so Sphinx renders a per-release table of contents in the sidebar, making long changelog sections easier to navigate. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged #5070 via commit 1b6b0cb42, adding a sidebar table of contents linking each changelog release, improving navigation for long, chronologically ordered release notes. | |
| qwen/qwen3.6-35b-a3b | — | — | Merged documentation changes adding a sidebar table of contents to the changelog page. Improves navigation for major versions with multiple hotfixes. Approved by three reviewers and merged despite a transient spread test failure due to a Launchpad outage. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation changes adding a sidebar table of contents to the changelog page, improving navigation for chronologically ordered version entries. Approved and merged despite a transient spread test failure caused by a Launchpad connectivity issue. |
Update history
No update history recorded yet.
Related work
-
Related To:
canonical/snapcraft#5355
(confidence 40%)
Later commit 8b7d1fc5a 'docs: migrate release content' rewrote the changelog/release notes area, but the :tocdepth: 2 setting was preserved.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #179 docs: add changelog to Sphinx docs | fetch-service | merged | Merged PR #179 added the changelog to the Sphinx documentation in commit ebd0909. | |
| #1814 Add changelog to sphinx docs | charmcraft | closed | Added docs/reference/changelog.rst and backfilled prior releases via merged PR #1841 (commit 3f0dbc6c), closing the request for a Sphinx changelog. | |
| #121 docs: fix changelog bug fixes markup | craft-platforms | merged | Merged PR #121 as commit 4963af6, correcting the Bug Fixes markup in docs/reference/changelog.rst. | |
| #1066 docs(changelog): add changelog for 2.8.0 | craft-parts | merged | Docs-only PR adding 2.8.0 release notes (9 lines) to docs/reference/changelog.rst; merged as commit 1eef8ebd with all CI checks passing, after the cargo-use plugin PR #1062. | |
| #354 docs: move changlog to docs toplevel directory | craft-parts | merged | Merged in PR #354 via commit 4c6375db, moving the changelog to the docs top-level directory for easier discovery. |