Notification: simple stable-latest version warning logic#125
Conversation
I implemented the simple idea exposed in #71. I think we can start with this simple logic that's easy to explain and grow from here if necessary. - on `latest`: a notification to warn the user about some features may not yet be available is shown - on non-`stable` nor `latest` versions: a notification to warn the user about possible reading and old/outdated version is shown Note that both notification are pretty simple, it does not require external dependencies (e.g. `semver`) and it's easy to explain to users. The warning is shown only if `stable` is an active version --since we link to it from both. _However_, I think the best way for users to make usage of this addon is by implementing the logic that fits their needs by themselves. We don't allow users to customize this logic just yet, but we plan to do it in the future when the addons is more settled down. Closes #71
I use a "bird" meaning "canary version" of this documentation. We can use something different here, tho. The idea is to visually differentiate the notifications somehow to avoid reading the text over and over again.
|
I received some small feedback to "visually differentiate" the notifications. So, I'm using a "bird" icon to denote "canary version" of this documentation when showing the
|
|
I love the "canary in the coalmine" metaphor but not sure if all users could relate to that 😅 what about something like GNU I.M.P. does with their beta versions, using "experimental" metaphors like 🧪 or 🧑🔬 or ☣️ or similar?
In any case, I think this is too easily bikesheddable, so just my two cents 🏳️ |
|
And maybe for "old" versions something that relates to "time", like ⌛ or 🕰, or even 🥀, or "abandoned" like 🕸 |
👍🏼 -- let me do a quick test |
|
I think they look great! 🚀
|
agjohnson
left a comment
There was a problem hiding this comment.
These look great! I agree the differentiation is a solid improvement.
… humitos/stable-latest-version-logic
|
I'm merging this PR and it will be deployed tomorrow. Also, I'm creating two issues to work on the feedback that I received from a conversation on slack: https://readthedocs.slack.com/archives/C029M3W01KR/p1694685981299249 |
I implemented the simple idea exposed in #71.
I think we can start with this simple logic that's easy to explain and grow from here if necessary.
latest: a notification to warn the user about some features may not yet be available is shownstablenorlatestversions: a notification to warn the user about possible reading and old/outdated version is shownNote that both notification are pretty simple, it does not require external dependencies (e.g.
semver) and it's easy to explain to users. The warning is shown only ifstableis an active version --since we link to it from both.On
latestOn non-
stableHowever, I think the best way for users to make usage of this addon is by implementing the logic that fits their needs by themselves. We don't allow users to customize this logic just yet, but we plan to do it in the future when the addons is more settled down.
Closes #71