-
-
Notifications
You must be signed in to change notification settings - Fork 18.5k
WEB: Link from the website to the docs #30891
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
Conversation
I actually find navigating to these from the dropdown on the main page pretty nice (save Older Versions, which doesn't work) - this does away with those right? |
I'm ok with the dropdown too, but it requires deciding which items we want on it, and find agreement on wherever we want the dropdown or not (I think @jorisvandenbossche didn't want it). Given that we're releasing soon, and one of the links is broken, I thought it was better to go for this simple option. And we can add the dropdown back in a follow up. |
Yeah, in many cases, I don't like much dropdowns (but for sure sometimes there are good use cases for it). In this specific case, I find personally that it doesn't add value. For example, right now, to go to the user guide, it takes 2 clicks (docs dropdown + user guide). If it's not a dropdown, but just a link to the docs, this also takes 2 clicks, so not much difference IMO (although your mouse will need to move a bit more between both clicks). But in addition, you are directly on the doc page, and can also click on anything that is not in the dropdown. |
For the versions, we could already add a simple page (to the web/ ?) that just lists them. I was working on a feature in the sphinx theme to add a version dropdown (yes, a dropdown! ;)), but didn't find the time yet to finish that |
Closing this, since it's more controversial than expected. Opened an issue for the discussions: #31061 |
Personally, I would rather merge this for now (or otherwise at least remove the broken versions link) |
Objections to merge this as short-term fix? (since people start to report the broken link) |
Merging this so we at least don't have a broken link for the v1.0.1 update (the website still is updated manually right now when we release, it's not yet automated from github) We can still further discuss which links we want to include here (eg the versions are right now also not yet available on the docs itself) |
The navigation of the web was implemented assuming the docs will render with the same layout. Since this is not finally the case, and the website and the docs are finally independent, I guess it makes more sense to simply link to the home of the docs.
Otherwise, we'd need to rethink those links, since the last one is broken, and the rest are inconsistent with the navigation of the docs.
Closes #31657