Skip to content

Improve topbar crate dropdown menu by removing uneeded information #1259

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

Merged
merged 2 commits into from
Feb 15, 2021

Conversation

GuillaumeGomez
Copy link
Member

I always found the link to go to the crate page very misleading because you don't expect a description to be this link. Instead, I removed this description from the menu completely (I think the menu is already very loaded) and made it clear what the link was about.

Screenshot from 2021-01-22 15-01-20

@jyn514
Copy link
Member

jyn514 commented Jan 23, 2021

@GuillaumeGomez instead of adding a new link text that's always the same, what do you think about making 'Regex 1.3.1' a link?

@GuillaumeGomez
Copy link
Member Author

Because it's not "obvious" when reading it. The problem I had with most of the original items is that I needed to look at the href to know what they were about.

@jyn514
Copy link
Member

jyn514 commented Jan 24, 2021

@GuillaumeGomez this already has a link to /crate under 'more information' on the sidebar:

image

So I don't think it makes sense to add another link, and I kind of like having the description. I would be ok with making the title a link instead of the description, but otherwise I don't see much point to this.

@GuillaumeGomez
Copy link
Member Author

I didn't even realize there was a "more information" link. What about I remove it? :)

@Nemo157
Copy link
Member

Nemo157 commented Jan 25, 2021

We definitely do need to do something about the embedded description, it gets really over the top sometimes e.g. https://docs.rs/chess/3.1.1/chess/. Removing it does seem like the easiest approach, the majority of the time it seems like this will just be a duplicate of the first few sentences of the crate-level docs.

As another point towards minimizing our exposure of the description, on crates.io you get to see the description for about a second before it is replaced by the readme; afaict there is no way to then go back to viewing the description.

I feel like the "More Information" link is a bit hidden, I have personally been using the description as the link, but I think it makes more sense than adding another link under the crate name. Maybe we could have both the "More Information" link and make the name a link?

@GuillaumeGomez
Copy link
Member Author

I think the menu should be minimalist and that the docs.rs crate page link should be easier to find. So I'm fine with removing the "More information" link.

Now, the big remaining quest is either we turn the crate name into this link (but then, it's not explicit where it's leading to so I'm not a big fan) or keeping the "docs.rs crate page" I suggested.

@jyn514
Copy link
Member

jyn514 commented Feb 4, 2021

I think we should get rid of 'More information' and make the crate name a link. I think that's clear enough, you only have to click it once to find what it does.

@GuillaumeGomez
Copy link
Member Author

I agree for removing "more information", but why someone would expect that clicking on the crate name would bring to another page? It's not obvious at all.

@GuillaumeGomez
Copy link
Member Author

I removed the "More information" link which was now a duplicate.

Copy link
Member

@jyn514 jyn514 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well, I'm still not convinced the separate link is better than making the crate name a link, but it's certainly better than the current behavior.

@jyn514 jyn514 added the S-waiting-on-author Status: This PR is incomplete or needs to address review comments label Feb 15, 2021
@GuillaumeGomez GuillaumeGomez added S-waiting-on-review Status: This pull request has been implemented and needs to be reviewed and removed S-waiting-on-author Status: This PR is incomplete or needs to address review comments labels Feb 15, 2021
@jyn514 jyn514 merged commit df7bb5c into rust-lang:master Feb 15, 2021
@GuillaumeGomez GuillaumeGomez deleted the topbar-remove-unneeded-info branch February 15, 2021 14:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-review Status: This pull request has been implemented and needs to be reviewed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants