insightsengineering / r-pkgdown-multiversion

Github Action to generate multiple versions of pkgdown docs for R packages
https://github.com/marketplace/actions/r-pkgdown-multi-version-docs
Apache License 2.0
4 stars 0 forks source link

Provide clarification text on Version Tab #5

Closed bms63 closed 2 years ago

bms63 commented 2 years ago

A new user to admiral might be confused on the different versions of the website. Providing some clarification text might help to mitigate this confusion.

image

Perhaps

bms63 commented 2 years ago

Also could main go on top?

cicdguy commented 2 years ago

So to summarize - there are 2 features being requested here:

  1. The ability to add additional text or an alternate text in the dropdown menu for a given branch/tag
  2. The ability to select a custom sort order of branches/tags in the dropdown (currently ascending)

Both are feasible. Will keep you posted when these have been implemented.

cicdguy commented 2 years ago

@bms63 Given the length of the text in the examples you provided, specifically:

These might be too long for a dropdown menu. Would you prefer a tooltip that you can hover over to get that info? Or just plain text (which will adversely affect UI/UX elements)?

bms63 commented 2 years ago

I think tool tip makes sense with a little text

Tooltip main - CRAN package Tooltip devel- Development version of package

cicdguy commented 2 years ago

Agreed, both would actually be nice.

arkadiuszbeer commented 2 years ago

Something like this: image

cicdguy commented 2 years ago

@bms63 ☝ WDYT of this?

bms63 commented 2 years ago

wow that is super nice

cicdguy commented 2 years ago

Feature's been merged. I'll begin testing this across repos. FYI @bms63 this will be in admiral.* soon as all test cases succeed.