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

Removing Here be Dragons warning in latest in favor of Read The Doc's own warning #10202

Open
mhilbrunner opened this issue Nov 4, 2024 · 3 comments

Comments

@mhilbrunner
Copy link
Member

mhilbrunner commented Nov 4, 2024

We have this warning on latest pages:

image

As of the new RTD changes, RTD now has their own version of this, a modal that pops up looking like this:

image

We can disable that, but we may actually want to instead remove our own version and go with this "native" one. Removing our version would improve search results, where currently, our warning is indexed:

image

Additionally, RTD's version will likely be better supported in the long term, and is also more lightweight.

@tetrapod00
Copy link
Contributor

tetrapod00 commented Nov 4, 2024

The native RTD version seems to be a popup that, once closed, does not reappear, even after switching docs versions to and from latest or navigating to another page. That makes our custom implementation more usable, IMO. Tested casually with Firefox, Edge, and Chrome on Windows 10.

Also, would the native popup have the same problem with covering content that the flyout menu does (see #10094)?

Overall I'm neutral. The RTD version is not clearly better in all cases, but it might be worth switching anyway for maintenance reasons.

@mhilbrunner
Copy link
Member Author

Also, would the native popup have the same problem with covering content that the flyout menu does

It sadly does. Kinda solved by the above (it only appears once), but that does indeed have downsides.

@Piralein
Copy link
Member

Piralein commented Nov 4, 2024

I would be in favor of the rtd implementation for future proof reasons, but yea it needs to cook a little bit longer.

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

No branches or pull requests

3 participants