bluerobotics / bluerobotics/bluetheme

add version staleness indicator

Open
#23 2 comments 0 reactions 0 assignees View on GitHub
appearance enhancement good first issue
Dominant language
JavaScript
Stars
5
Forks
3
PR merge metrics
No merged PRs in 30d

Description

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

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the page template and version selector, then review the related ideas in #3 and bluerobotics/ardusub-zola#58. Define how fixed releases, latest, and stable should indicate recency and availability of newer documentation. Done means the page communicates version staleness and the selector provides a clear visual distinction across versions.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.