Notification: allow to disable `latest` and/or non-`stable` warning

[humitos]

The current pretty simple logic we have is good and it may work for most of the cases. However, it's a little verbose since it will show a notification in all the versions that are not stable --which could be a lot.

There are users that won't like this pattern and may not want to follow "our proposal to use the platform" here (most users should always read the stable version of the project's documentation) or may require an un-supported way to decide "stable" version.

These users should be able to decide whether or not show a warning notification on latest and/or on non-stable versions independently:

• Enable the addons (disable it completely)
• Show a notification on non-stable versions
• Show a notification on latest version

Related

• 125

• https://github.com/readthedocs/ext-theme/issues/212
• https://github.com/readthedocs/ext-theme/issues/211
• https://github.com/cilium/cilium/issues/29969
• https://github.com/readthedocs/addons/issues/201

[Zylann]

Is it about this warning?

I started noticing it only a few weeks ago, and I don't know how to get rid of it. Many users of my project use its latest version and it's annoying. Also even if it were desired, it covers the top of every page, requiring action to dismiss it each time.

Also I notice this is an "addon", but I don't remember setting this up anywhere? (new to this repo, maybe it's not what it means)

[humitos]

Hi @Zylann. This is new to Read the Docs as well. We have been migrating a lot of features we used to perform in the backend build process to a front-end application.

You can read more about this in our blog:

• https://blog.readthedocs.com/addons-flyout-menu-beta/
• https://about.readthedocs.com/blog/2024/04/enable-beta-addons/

Note that you can disable this notification from your project's setting using the beta dashboard (more info about this in the second blog post). Let me know if that helps.

[agilgur5]

Also even if it were desired, it covers the top of every page, requiring action to dismiss it each time.

Yes, this is pretty annoying, especially for contributors who use latest regularly (see also this thread in CNCF Slack for Argo Workflows contributors).

If it were less obtrusive or had a cookie or checkbox to remember that I hid it, that would be much nicer. For instance:

• default to hide it for a week
• allow users to optionally hide it -- some are well aware they are on a different version than stable
• make it smaller at the top of the page, like a banner. as an example, here is mkdocs-material's version warning that is just above the header and so can just be scrolled past very easily. (all core Argo projects use mkdocs-material, for reference)

Otherwise, given how obtrusive it currently is, we will probably disable it entirely. I found this issue searching for how to disable it.

[humitos]

Thanks for your feedback @agilgur5 👍

If it were less obtrusive or had a cookie or checkbox to remember that I hid it, that would be much nicer

This is already implemented and will be deployed next week.

[humitos]

I just deployed a new version of the addons that includes the ability to dismiss a notification and not show it again on the same project/language/version. Feel free to open a new issue with any feedback you may have. Thanks 🙏🏼 cc @agilgur5

[agilgur5]

includes the ability to dismiss a notification and not show it again on the same project/language/version

Looks like it happens automatically? I didn't see an option, but I do see it remembers the dismissal and stores a timestamp in localStorage.

Looks like per #283 it's just permanent for now? And I see this issue is roughly a duplicate of #46

[humitos]

@agilgur5 yes, it's permanent for now. We released this simplified version as a first step, but we plan to improve it with the feedback we receive.