Skip to content

Idea: Show small badge to jump to newest version #57

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

Closed
bluss opened this issue Sep 25, 2016 · 15 comments
Closed

Idea: Show small badge to jump to newest version #57

bluss opened this issue Sep 25, 2016 · 15 comments

Comments

@bluss
Copy link
Member

bluss commented Sep 25, 2016

Imagine you're browsing the slightly outdated docs of some project: https://docs.rs/regex/0.1.75/regex/

There could be a small badge that's visible in that case (maybe yellow or orange) that lets you jump to the current version (“Version 0.1.77 is the most recent release”).

It's important for this feature that the badge is not shown if you're already at the newest release.

Versioned links are going to be very useful, but this could be a small help if you have users arrive to stale docs via old links without them being aware of it.

@onur
Copy link
Member

onur commented Sep 26, 2016

This is an awesome idea.

But where should I put this badge? Any suggestions?

And do you think docs.rs badges are enough? i.e: regex crate: regex

@bluss
Copy link
Member Author

bluss commented Sep 26, 2016

Something self-explanatory, like image

@onur
Copy link
Member

onur commented Sep 26, 2016

TBH this kinda looks ugly to me: shields.io-example

@bluss
Copy link
Member Author

bluss commented Sep 26, 2016

Location:

I was thinking it wants to be on every single documentation page, not just the crate root (again thinking of the case when you arrive through some external link or old bookmark). Maybe top right corner, above the Platform selector and the description? (Looking at this page as a random example (page))

@bluss
Copy link
Member Author

bluss commented Sep 26, 2016

I doesn't have to be those particular "badges". Just text with some background color to make it stand out just a small amount.

@onur
Copy link
Member

onur commented Sep 26, 2016

I see.

Let me see what I can do without breaking page's minimalistic style and default look and feel.

@onur
Copy link
Member

onur commented Sep 26, 2016

This is what I got after few tries, I think it looks cool:

docs.rs

@bluss
Copy link
Member Author

bluss commented Sep 26, 2016

Yeah that looks great

@Yamakaky
Copy link

Maybe more "Last version" than "Recent version". Or maybe something "you are seeing an outdated version, here to see the last"

@onur
Copy link
Member

onur commented Sep 26, 2016

Since we got #58 I am planning to show only version number and a dropdown menu to all versions and if version isn't the latest version I will show it orange.

@bluss
Copy link
Member Author

bluss commented Oct 26, 2016

This is a crucial feature since old crate versions’ docs are placed high on google already.

@onur onur added the important label Dec 28, 2016
@onur
Copy link
Member

onur commented Mar 22, 2017

Since I introduced new navigation for rustdocs, it is more easy to add this warning. What do you think about this kind of warning? @bluss @Yamakaky

zzz

@bluss
Copy link
Member Author

bluss commented Mar 22, 2017

That looks perfect!

@bluss
Copy link
Member Author

bluss commented Mar 22, 2017

New narrower docs.rs header is very good, too.

@onur onur closed this as completed in 0053932 Mar 22, 2017
@bluss
Copy link
Member Author

bluss commented Mar 22, 2017

Thanks a lot for implementing this!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants