Notify users using when they are viewing the development docs

[jorgepiloto]

Hi all 👋🏽,

I am raising a poll about whether or not we should add an announcement when users are reading the development documentation. This feature was suggested last week and we would love to know your thoughts about whether to implement it or not.

The announcement would be similar to the one showing under the top navigation bar when users are viewing an outdated version of the documentation:

[da1910]

I'd suggest making it a different color, but it's certainly useful to know!

[PProfizi]

Not sure you'd have to redirect to the latest stable though if that's something complicated to do.

[greschd]

@da1910 not sure if that's the suggestion, but I think at least the "outdated" warning should be more prominent than just color-coding. I think the banner works well for that. For the dev version, maybe color is enough.

If we go for a banner, a "friendly" color like green would also be sufficient IMO. It would stand out simply by the fact of being a banner (as opposed to no banner on stable).

[germa89]

I agree with @greschd we need the banner for the outdated versions.

Regarding the color for dev I would propose yellow/orange. Green might look like "everything is fine", which might not be the case.

[da1910]

I agree about the banner, the button coloring isn't clear enough for me, I was only including the screenshots to indicate the color choices!

[timdansys]

Regarding semantic color usage, we use the following approach:

• Red: Errors, dangerous or destructive actions or statements
• Yellow: Warnings, caution
• Blue: Informative statements
• Green: Success

With that in mind, the proposed message that the user is reading the development documentation would be a warning or a caution (yellow) because the user may not know this isn't the latest stable version.

We also do not want to present a warning message with a dead end - we need to provide a link to the latest stable version, unless it's obvious how to get to the latest stable version.