docs: improve sidebar for the changelog page #5070
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mr-cal
reviewed
Sep 27, 2024
There was a problem hiding this comment.
What do you think about setting a max depth such that only the contents only show the top-level versions are shown and not the sub-headings? I'm not sure if it's possible.
A few weeks ago, I tried to figure out how to do it on the right-hand page navigation (see attached) but gave up because I couldn't figure out how to do it without html/css hacking.
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.
tigarmo
force-pushed
the
work/changelog-toc
branch
from
c967bbc
to
cd81d0c
Compare
|
@mr-cal what a coincidence, I had the same thought and managed to find a way to do it (don't ask me how) |
tigarmo
changed the title
mr-cal
approved these changes
Sep 27, 2024
lengau
approved these changes
Sep 27, 2024
medubelko
approved these changes
Sep 27, 2024
|
spread test failure is a launchpad connectivity issue, merging anyway |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
These two facts:
... 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.
tox run -m lint?tox run -e test-py310? (supported versions:py39,py310,py311,py312)