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

add version staleness indicator #23

Open
ES-Alexander opened this issue Dec 1, 2024 · 2 comments
Open

add version staleness indicator #23

ES-Alexander opened this issue Dec 1, 2024 · 2 comments
Assignees
Labels
appearance Issues related to the theme styling enhancement New feature or request good first issue Good for newcomers

Comments

@ES-Alexander
Copy link
Collaborator

ES-Alexander commented Dec 1, 2024

The version selector tells you which version you are viewing docs for, but for fixed release numbers needs to be clicked on to get a sense of whether that release is recent or old, and for latest/stable it may not be obvious that the other is available to view.

It would be helpful to have some indicator/message/banner as part of the page template that specifies whether the version being looked at is up to date, or if there are more recent docs that should be referred to.

As part of that (and building on #3), it may be worth colouring the displayed version(s) in the selector with a colour range representing the staleness of versions (e.g. blue or purple for latest, green for stable, and orange to red for old releases).


Inherits ideas from bluerobotics/ardusub-zola#58

@ES-Alexander ES-Alexander added enhancement New feature or request good first issue Good for newcomers appearance Issues related to the theme styling labels Dec 1, 2024
@ES-Alexander ES-Alexander changed the title add latest versions indicator add version staleness indicator Dec 1, 2024
@InderParmar
Copy link

Hi, I am interested in working on this issue, can you please assign this issue to me. Thanks!

@ES-Alexander
Copy link
Collaborator Author

Hi @InderParmar, thanks for your interest in contributing! 😃

Happy to assign this to you.

Note that adding colours to the version selector may not make much sense until #3 is complete, but adding a banner or indicator should already be possible by checking whether /docs/latest or /docs/stable is in the config.base_url 🙂

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
appearance Issues related to the theme styling enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants