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
allow to dismiss announcement bars #1384
Comments
|
+1 on this feature. My preference would be option 3:
Docusaurus follows the approach from option 3. We could also have a look at how they achieve this. Also, I am pinging @smeragoel in case she has other valuable UX insights. |
If we were to do a pro/con of each option, here's how that'd go: Option 1:
Option 2:
Option 3:
I feel that if users work across different versions then it may be more user-friendly to implement Option 2. It would provide a balance between convenience and ensuring users are aware of important information. But I understand @trallard's point, and in that case, we could introduce |
Just to enphasis again why I thing any implementation of 3 is a bad idea with a use case that I did just now on my computer:
My point is, I land on PST based documentation searching on google and I'm pretty sure my way of searching is standard. As long as you do this and depending on your search tool/parameter/history people could change version without knowing it, so to me me "don't show again" even if fancy is not adapted to multi-version technical documentation websites. |
I think we might be conflating or confusing banners. When I think of an announcement banner it can be like the one we have in our docs "Pydata sphinx is an open source project..." "numpy sprints at scipy" things like that. I suppose we can allow for these to be dismissed for a version or until these banners are updated so folks do not miss information. While version warning banners are a different thing (and I think those are still in progress) - but basically tells you "this is not the most up to date version". These make sense not to dismiss them forever. So my suggestion was more about the former than the latter. |
My bad there was effectively a confusion. And then yes 3 makes sense because once you know "Pydata sphinx is an open source project" do you really need a reminder on daily basis ? 😄 |
this came up in SciPy with respect to version warning banners. I think option 2 makes most sense. Option 3 makes no sense in this context, and option 1 would probably cause a bit of annoyance. |
…sion. See pydata#1384 I think we all agree that if a user dismiss the banner it should apply to all pages. One remaining questions is : - does it apply to all versions ? This implement a rough dismiss button and store in local storage which version and **when** the user has dismissed it. I think this is enough informations to refine the logic later with what/when we want to show. This also has a rough implementation of not showing banner for current version for the next month following any banner dismissal. We could do the same for announcement (not implemented here), but also keep a hash of the announcement to re-show on new-announcement, but that's for another PR. CSS/HTML to refine, but I'll need help for that.
…sion. See pydata#1384 I think we all agree that if a user dismiss the banner it should apply to all pages. One remaining questions is : - does it apply to all versions ? This implement a rough dismiss button and store in local storage which version and **when** the user has dismissed it. I think this is enough informations to refine the logic later with what/when we want to show. This also has a rough implementation of not showing banner for current version for the next month following any banner dismissal. We could do the same for announcement (not implemented here), but also keep a hash of the announcement to re-show on new-announcement, but that's for another PR. CSS/HTML to refine, but I'll need help for that.
I'm attempting something in #1763 if some of you are interested. |
#1354 adds a version warning bar in addition to our announcement bar. It would be nice if users could click an X to dismiss the announcements/warnings (they take up quite some space at the top of every page). Not sure how easy it is to persist that setting (or if we even want to do that), seems like options ought to be:
I lean toward the simplest (option 1) but I'm open to being convinced otherwise.
The text was updated successfully, but these errors were encountered: