Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve version selector to stay on the same page #678

Closed
farshidtz opened this issue Jan 26, 2022 · 1 comment
Closed

Improve version selector to stay on the same page #678

farshidtz opened this issue Jan 26, 2022 · 1 comment

Comments

@farshidtz
Copy link
Member

farshidtz commented Jan 26, 2022

This is a known issue: After a version switch, the user is thrown back to the home page.

This makes it very hard to switch between different versions and find the right page. Moreover, it adds huge maintenance burden when releasing new versions, because every single link needs to be updated to avoid this broken experience. In some cases, we've relied on textual directions so that a user can find the page without us having to give a fixed URL.

The new mike material for mkdocs solves this problem with the stay on page feature. See the demo. Mike also warns the users looking at an old version.

But switching to mike is not as easy as it sounds. There may be template, CI issues, and additional work needed to support the legacy fuji version switch.

I'm working on a simpler fix for now.

@farshidtz
Copy link
Member Author

A fix has been added to ireland, jakarta, and main branches. See PR backlinks above.

For hanoi and geneva, I could not merge the fixes due to CI failures that were beyond the scope of that fix.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant