Skip to content

Commit

Permalink
docs: add a table of contents for the versions
Browse files Browse the repository at this point in the history
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 that links to the subsection for each release.
  • Loading branch information
tigarmo committed Sep 26, 2024
1 parent 5ea2c39 commit c967bbc
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/reference/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,10 @@ Changelog

For a complete list of commits, check out the `X.Y.Z`_ release on GitHub.

.. contents::
:class: this-will-duplicate-information-and-it-is-still-useful-here
:local:

8.4.1 (2024-Sep-20)
-------------------

Expand Down

0 comments on commit c967bbc

Please sign in to comment.