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

Make rustdoc icons more consistent #91309

Open
jsha opened this issue Nov 28, 2021 · 14 comments
Open

Make rustdoc icons more consistent #91309

jsha opened this issue Nov 28, 2021 · 14 comments
Assignees
Labels
A-rustdoc-ui Area: Rustdoc UI (generated HTML) E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. E-help-wanted Call for participation: Help is requested to fix this issue. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@jsha
Copy link
Contributor

jsha commented Nov 28, 2021

Here's a sample of some icons used in rustdoc:

image

Here are some used in docs.rs:

image

Here are some used on crates.io:

image

We should make the rustdoc icons internally consistent, and ideally consistent with related Rust sites as well. It looks like both docs.rs and crates.io are using SVGs from fontawesome's free set: https://github.com/rust-lang/docs.rs/tree/master/crates/font-awesome-as-a-crate/fontawesome-free-5.14.0-web/svgs/regular.

@jsha jsha added T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. A-rustdoc-ui Area: Rustdoc UI (generated HTML) labels Nov 28, 2021
@inquisitivecrystal
Copy link
Contributor

inquisitivecrystal commented Nov 28, 2021

At a glance, it looks to me like fontawesome's free set has alternatives for all of the sample icons!

@jyn514 jyn514 changed the title Consistentize rustdoc icons Make rustdoc icons more consistent Nov 30, 2021
@jyn514 jyn514 added E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. E-help-wanted Call for participation: Help is requested to fix this issue. labels Nov 30, 2021
@Rustin170506

This comment has been minimized.

@Rustin170506 Rustin170506 removed their assignment Dec 1, 2021
@pitaj
Copy link
Contributor

pitaj commented Dec 4, 2021

@rustbot claim

@pitaj
Copy link
Contributor

pitaj commented Dec 4, 2021

Here are my planned replacements:

brush.svg -> solid/paint-brush.svg

wheel.svg -> solid/cog.svg

unicode -> solid/info-circle.svg

clipboard.svg -> solid/copy.svg

emoji 🔬 -> solid/microscope.svg

emoji 👎 -> solid/thumbs-down.svg

image

unicode -> solid/exclamation-triangle.svg

image

down-arrow.svg -> solid/chevron-down.svg

image

toggle-minus.svg -> solid/minus-square.svg

image

toggle-plus.svg -> solid/plus-square.svg

I kept with the solid theme throughout, as that appears to be what docs.rs uses.

@pitaj
Copy link
Contributor

pitaj commented Dec 4, 2021

Some alternatives:

"experimental" microscope: flask

"hide" toggle-minus: regular/minus-square

"expand" toggle-plus: regular/plus-square

Or we can choose to not change the hide/expand toggle.

@jsha
Copy link
Contributor Author

jsha commented Dec 5, 2021

Thanks for putting these proposals together!

clipboard.svg -> solid/copy.svg

The clipboard icon we have is actually copied from docs.rs' choice already. See e.g. https://docs.rs/crate/rustls/latest. We should keep the clipboard icon the same.

cog, brush, info circle, warning triangle all look great. For "experimental" I like the flask better than the microscope (and the flask is also used on MDN, a very well-respected documentation site).

Let's not change the hide/expand toggle just yet. That's such a big part of the UI it deserves separate consideration.

I also started a Zulip thread to get feedback from the rustdoc team.

@camelid
Copy link
Member

camelid commented Dec 5, 2021

Hmm, for the microscope and the thumbs-down, I kind of like that they're currently colorful. The proposed icons for those are a little intense IMO. I also agree that we should use a flask instead of a microscope if we're changing the icon.

@pitaj
Copy link
Contributor

pitaj commented Dec 5, 2021

@camelid what do you mean when you say that the proposed thumbs-down icon is intense? I generally think of colorful things as more intense.

@pitaj
Copy link
Contributor

pitaj commented Dec 5, 2021

My current plan (which I intend to execute on today) is this:

brush.svg -> solid/paint-brush.svg

wheel.svg -> solid/cog.svg

unicode -> solid/info-circle.svg

emoji 🔬 -> solid/flask.svg

emoji 👎 -> solid/thumbs-down.svg

image

unicode -> solid/exclamation-triangle.svg

image

down-arrow.svg -> solid/chevron-down.svg

And I plan on pulling in font-awesome-as-a-crate to provide the icons. This is what docs.rs does, so this will keep us up-to-date with them.

@camelid
Copy link
Member

camelid commented Dec 7, 2021

@camelid what do you mean when you say that the proposed thumbs-down icon is intense? I generally think of colorful things as more intense.

The proposed icon is a solid color, whereas the existing one has gradients. But I'm fine with trying the new one; we can always tweak it later.

@aycippo
Copy link

aycippo commented Nov 4, 2023

pinging this to see if it should be closed, or still has relevance.

@Aditya-PS-05
Copy link
Contributor

@camelid, can you assign me this issue?

@chenyukang
Copy link
Member

@camelid, can you assign me this issue?

This issue is now unreleased, you can claim it if you want.

@ExquisitePenguin
Copy link

ExquisitePenguin commented Feb 28, 2025

I will open a pr soon

@rustbot claim

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-rustdoc-ui Area: Rustdoc UI (generated HTML) E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. E-help-wanted Call for participation: Help is requested to fix this issue. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

10 participants