Skip to content

Make docs.rs documentation more visible on website #825

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
XAMPPRocky opened this issue Jun 8, 2020 · 11 comments
Closed

Make docs.rs documentation more visible on website #825

XAMPPRocky opened this issue Jun 8, 2020 · 11 comments
Labels
A-frontend Area: Web frontend E-medium Effort: This requires a fair amount of work

Comments

@XAMPPRocky
Copy link
Member

XAMPPRocky commented Jun 8, 2020

There is documentation for docs.rs' crate metadata in the source, but it isn't accessible from the website, which makes hard for users to find. It would be nice if there was a page on the website that explained what metadata you can and should set.

@XAMPPRocky
Copy link
Member Author

I missed that this is available under "about docs.rs" under "Rust". Though it wasn't obvious to me that, that's where I should be looking.

@Nemo157
Copy link
Member

Nemo157 commented Jun 8, 2020

I have long thought the location of "about docs.rs" was really weird and annoying to find, feel like reopening this as making it more obvious somehow? (Maybe the current about page should be split into "about docs.rs" and "docs.rs documentation"? And the top-level menu renamed somehow?)

@XAMPPRocky
Copy link
Member Author

XAMPPRocky commented Jun 8, 2020

Yeah I think it would be good to split the website's about to the top level of the nav.

@Nemo157 Nemo157 changed the title Document and link to metadata on website Make docs.rs documentation more visible on website Jun 8, 2020
@Nemo157 Nemo157 reopened this Jun 8, 2020
@jyn514
Copy link
Member

jyn514 commented Jun 8, 2020

@Kixiron plans to work on this as part of #740.

@jyn514 jyn514 added A-frontend Area: Web frontend E-medium Effort: This requires a fair amount of work S-blocked Status: marked as blocked ❌ on something else such as an RFC or other implementation work. labels Jun 8, 2020
@jyn514 jyn514 removed the S-blocked Status: marked as blocked ❌ on something else such as an RFC or other implementation work. label Jul 14, 2020
@jyn514
Copy link
Member

jyn514 commented Aug 14, 2020

@XAMPPRocky we split this up in #924. How does it look now?

image

@XAMPPRocky
Copy link
Member Author

XAMPPRocky commented Aug 15, 2020

It looks good to me, aside from the fact that the top bar is radically different when you're looking at a crate vs docs.rs pages on mobile. I would expect them to be consistent.

Home

image

Crate

image

@jyn514
Copy link
Member

jyn514 commented Aug 15, 2020

Hmm well I agree the design is pretty inconsistent, but the information is different on those two pages. On the main page, it's information about docs.rs itself, while on /crate it's information about that specific crate. This is the same page on desktop so you can see the titles:

image

Maybe we should consider adding the labels on mobile too? Or adding the docs.rs header to /crate and rustdoc pages?

@jyn514
Copy link
Member

jyn514 commented Oct 22, 2020

@XAMPPRocky we redid this again in #1089. What do you think now?

Main page:
image
Rustdoc pages:
image
/crate pages:
image

@XAMPPRocky
Copy link
Member Author

XAMPPRocky commented Oct 22, 2020

@jyn514 Looks great! I found a minor bug where the gear icon doesn't work on tap on iOS if there's no targets, but it's nice and consistent now.

@jyn514
Copy link
Member

jyn514 commented Oct 22, 2020

Awesome! Can you open a new issue for the iOS bug?

@jyn514 jyn514 closed this as completed Oct 22, 2020
@jyn514
Copy link
Member

jyn514 commented Oct 22, 2020

Actually - I think that might be intentional, there's no platforms to display if there's no targets. The bug is that we still display the dropdown, not that it doesn't do anything.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-frontend Area: Web frontend E-medium Effort: This requires a fair amount of work
Projects
None yet
Development

No branches or pull requests

3 participants