rubyapi icon indicating copy to clipboard operation
rubyapi copied to clipboard

Support `current` alias

Open andyw8 opened this issue 1 year ago • 6 comments

From the suggestion in https://github.com/rubyapi/rubyapi/pull/1417#issuecomment-1451696255

~I think current would be clearer though. latest might be interpreted as the latest commit on master.~

Closes https://github.com/rubyapi/rubyapi/issues/1215

andyw8 avatar Mar 04 '23 14:03 andyw8

Updated to use current.

andyw8 avatar Mar 04 '23 21:03 andyw8

I've not pulled this up locally yet, but do all of the links display as "current" or "3.2" when you pull up "current" documentation?

natematykiewicz avatar Mar 04 '23 21:03 natematykiewicz

As "3.2"

andyw8 avatar Mar 04 '23 21:03 andyw8

That seems fine for now. Maybe later we can support making those say "current", so that your documentation links don't lose that.

For example here: image

natematykiewicz avatar Mar 04 '23 21:03 natematykiewicz

That seems fine for now. Maybe later we can support making those say "current", so that your documentation links don't lose that.

For example here: image

I feel this PR is not really complete without this. It's great that we're allowing current, but i don't see what value to UX it provides when clicking on any link resets you back to the specific version.

Could we also have some tests to ensure this feature is working as intended?

Thanks.

colby-swandale avatar Mar 09 '23 02:03 colby-swandale

This would be great for something like a DuckDuckGo bang to search the docs.

FWIW, in that scenario it wouldn't be a problem for me personally if the links referred to the specific version 👍

cpjmcquillan avatar Apr 18 '23 21:04 cpjmcquillan