Merged
Conversation
This comment was marked as spam.
This comment was marked as spam.
amotl
approved these changes
Feb 20, 2026
Member
amotl
left a comment
amotl
left a comment
There was a problem hiding this comment.
Thanks. Let's try? Please squash a few commits, so we can more easily swap this out if it causes unforeseen problems.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary of the changes / Why this is an improvement
The TOC would always reset to the top of the TOC when clicking any links in the TOC. This could cause huge jumps and the TOC would navigate away from the selection you had just made. This results in confusion and the need to scroll back in the TOC menu to the item you had selected if you wanted to navigate deeper into a section.
All in all causing a bad user experience far from todays modern doc systems.
This is due to the design of Sphinx Core and there are no plans to change that. Every major Sphinz theme have tried to implement workarounds, except for Furo.
But with the use of Swup it's been possible to completely get rid of any flicking experience.
Also added animation of the icon transition (as this is now possible because we don't reload pages)
Preview
https://crate-docs-theme--709.org.readthedocs.build/en/709/tests/section1/subpage2.html
It's been tested with all projects projects via devtools/test-multi-project.sh
Better yet, try navigating Integration pages (or other pages in the "guide") https://cratedb-guide--555.org.readthedocs.build/integrate/metabase/index.html. And compare to existing docs.
Checklist