Skip to content

Changing menu bar on mobile #1120

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

Open
jsha opened this issue Oct 24, 2020 · 0 comments
Open

Changing menu bar on mobile #1120

jsha opened this issue Oct 24, 2020 · 0 comments
Labels
A-frontend Area: Web frontend A-rustdoc-css Area: CSS generated by rustdoc for documentation pages C-enhancement Category: This is a new feature

Comments

@jsha
Copy link
Contributor

jsha commented Oct 24, 2020

Related to #1103, #1104, #1096.

We've been talking about ways to make menus behave nicely across both desktop and mobile, where the desktop version uses click-to-open, and the mobile version uses links that take you to a separate page with equivalent functionality to the menu. It's definitely doable, but I wanted to step back and see if we want to change the mobile menus more dramatically.

docsrs-mobile

As you can see above, we have a bit of a confusing two-menu system. There's the docs.rs top menu, and the rustdoc hamburger menu. I know it's hard to reach into the internals of rustdoc from docs.rs, but it would be great to combine them! Then we could put all of the extra options behind the hamburger menu, where there's enough room to give them labels so people know what they do.

On a similar note, I was thinking about "what are the most important and common things people want to do" and "what pieces of context are most important."

For "what context is important," I think the main thing that people need to know if they in the middle of a docs.rs page is

  • what is the name of this package
  • what struct/trait/function's page am I on
  • if this is not the current version, I'd like an alert icon

For "what actions that might be in a menu are important," I think it's:

  • See what methods / fields are available on this item (already covered in Rustdoc's hamburger menu)
  • Go to the documentation root for the crate (already covered, by the rust icon / project icon)
  • Go to the repository
  • Go to the crates.io page OR the equivalent on docs.rs.
  • Select a different version (though this could be done from the docs.rs crate page).
  • Go to the homepage of docs.rs.

Anyhow, lemme know if you find the idea appealing, and we can brainstorm ways to do it.

@jyn514 jyn514 added A-frontend Area: Web frontend A-rustdoc-css Area: CSS generated by rustdoc for documentation pages C-enhancement Category: This is a new feature labels Oct 24, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-frontend Area: Web frontend A-rustdoc-css Area: CSS generated by rustdoc for documentation pages C-enhancement Category: This is a new feature
Projects
None yet
Development

No branches or pull requests

3 participants
@jsha @jyn514 and others