Skip to content
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

Rustdoc sidebar style improvements #40679

Closed
wants to merge 1 commit into from
Closed

Conversation

est31
Copy link
Member

@est31 est31 commented Mar 20, 2017

Some improvements of the sidebar style

  • The sidebar now has a visually more pleasant color.
    Its still different from the main site, so its still
    easy to spot a difference

  • Hovering the entries in the sidebar now has a
    discernible difference to the sidebar background,
    fixing a regression of commit 2bb2a29

  • The very unpleasant black border around the crate name has been removed.

Screenshot before the change: screenshot_20170320_183015

Screenshot after the change: screenshot_20170320_182916

@rust-highfive
Copy link
Collaborator

Some changes occurred in HTML/CSS.

cc @GuillaumeGomez

@rust-highfive
Copy link
Collaborator

r? @GuillaumeGomez

(rust_highfive has picked a reviewer for you, use r? to override)

@steveklabnik
Copy link
Member

/cc @rust-lang/tools

@GuillaumeGomez
Copy link
Member

I'm not a big fan of the current item not being in a white rectangle with a black border. Since it's a matter of taste, I think we'll have to wait for others' opinion.

@nrc
Copy link
Member

nrc commented Mar 22, 2017

If we are going to be changing the design of rustdoc, I would like to have a plan/vision for how we want it to look. Perhaps we could interest someone with design experience in doing a mock-up for us? I fear that iterating on design like this with no clear plan will lead to a lot of changes and a sub-optimal end point.

re these changes, I approve of losing the black box, but I think I prefer the previous higher contrast (even for someone with good eyesight, I find the white and pale grey difficult to distinguish).

@steveklabnik
Copy link
Member

Perhaps we could interest someone with design experience in doing a mock-up for us? I fear that iterating on design like this with no clear plan will lead to a lot of changes and a sub-optimal end point.

This is a long-term goal, and one I've been discussing with @aturon for a lot lately, but until we get there, iterative it is.

@bors
Copy link
Contributor

bors commented Mar 23, 2017

☔ The latest upstream changes (presumably #40748) made this pull request unmergeable. Please resolve the merge conflicts.

Some improvements of the sidebar style

* The sidebar now has a visually more pleasant color.
  Its still different from the main site, so its still
  easy to spot a difference

* Hovering the entries in the sidebar now has a
  discernible difference to the sidebar background,
  fixing a regression of commit 2bb2a29

* The very unpleasant black border around the crate name has been removed.
@est31 est31 reopened this Mar 23, 2017
@est31
Copy link
Member Author

est31 commented Mar 23, 2017

(had to rebase on top of #40725 -- apparently a subset of the changes I've proposed has already been merged independently)

replying to @nrc :

If we are going to be changing the design of rustdoc, I would like to have a plan/vision for how we want it to look. Perhaps we could interest someone with design experience in doing a mock-up for us?

Yes, I agree fully! In fact there is #37856 which contains some talk and some suggestions, and later #40265 went further and implemented an interpretation of the proposed suggestions. However, its a very recent change, and once I found out about it I immediately saw the issues with it that I'm trying to fix with this PR. So I agree with you that one might end up with something sub optimal, after all we have ended up with something sub optimal right now.

The border around the struct for example was only present in the draft screenshot, but nowhere in the proposal's text, and I'm sure the author would have came up with something better had they spent more time on it. I mean it makes the struct/mod/enum name appear like its the most important thing in the page, which isn't the case in my opinion.

It just points to the fact that the sidebar in the mock up is too dark and therefore you can barely go darker with the highlight of the struct name, or the selection. I solved this by making the selection a bit darker, and the sidebar a bit lighter.

@est31
Copy link
Member Author

est31 commented Mar 23, 2017

Also note that I don't want to waste too much time arguing on this rather unimportant thing (which is partly why I wouldn't have participated in #37856 even if had I known about it), when you plan an entire re-design of rustdoc already then its probably even worthless, I just couldn't let it stay in the state it was and thought I could improve the situation, hoping that the benefits were clear. I want to do more pleasant things than bikeshedding (or constantly rebase a PR of which I'm not sure on whether its actually wanted), so please, either merge it, or reject it.

@GuillaumeGomez
Copy link
Member

Well, like I said, except for the fix, I don't like the new colors. This is just a matter of taste so others should give their opinion as well.

@est31 est31 closed this Mar 31, 2017
@est31
Copy link
Member Author

est31 commented Mar 31, 2017

Seems there is not enough interest in this change being merged, closed it.

@GuillaumeGomez
Copy link
Member

@est31: Sorry about it. :-/

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

Successfully merging this pull request may close these issues.

6 participants