From cd81d0c94c69567e4fe0fc2b677360c0eef4a8af Mon Sep 17 00:00:00 2001 From: Tiago Nobrega Date: Thu, 26 Sep 2024 18:58:54 -0300 Subject: [PATCH] docs: improve sidebar for the changelog page 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. --- docs/reference/changelog.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/reference/changelog.rst b/docs/reference/changelog.rst index fbc344f8ac..42b485f78d 100644 --- a/docs/reference/changelog.rst +++ b/docs/reference/changelog.rst @@ -1,3 +1,5 @@ +:tocdepth: 2 + Changelog *********