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.

Sign up for GitHub

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

Jump to bottom

rustdoc: help widget oversized on mobile and can't scroll #77899

Open
jsha opened this issue Oct 13, 2020 · 6 comments
Open

rustdoc: help widget oversized on mobile and can't scroll #77899

jsha opened this issue Oct 13, 2020 · 6 comments
Labels
A-rustdoc-ui Area: rustdoc UI (generated HTML) C-bug Category: This is a bug. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@jsha
Copy link
Contributor

jsha commented Oct 13, 2020

Steps to reproduce:

  1. Visit a documentation page on crates.io on a mobile browser (Brave 1.15.73 / Chromium 86, Android 11 on a Pixel 3).
  2. Click the "?" icon next to the search box.

Expected result: Help dialog pops up

Actual result: Help dialog pops up, but is too big for the screen and not scrollable (see screenshot).

Note also that the keyboard shortcut section can probably be elided on mobile since there is usually no keyboard (though there can be!).

Screenshot_20201012-230926
@Nemo157
Copy link
Member

Nemo157 commented Oct 13, 2020

Appears to be a rustdoc issue, I can reproduce on https://doc.rust-lang.org/nightly/std/

@jyn514 jyn514 transferred this issue from rust-lang/docs.rs Oct 13, 2020
@jyn514 jyn514 added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Oct 13, 2020
@jyn514 jyn514 changed the title mobile: help widget oversized and can't scroll rustdoc: help widget oversized on mobile and can't scroll Oct 13, 2020
@jyn514 jyn514 added C-bug Category: This is a bug. A-rustdoc-ui Area: rustdoc UI (generated HTML) labels Oct 13, 2020
@GuillaumeGomez
Copy link
Member

Ah right, it wasn't possible before we added the button to have this popup. Maybe we should hide it when we're on mobile?

@GuillaumeGomez GuillaumeGomez mentioned this issue Oct 15, 2020
Merged
@GuillaumeGomez
Copy link
Member

#77979 is just a quick fix for now: we're still debating about whether or not we want to display this help popup and if so, how.

GuillaumeGomez added a commit to GuillaumeGomez/rust that referenced this issue Oct 15, 2020
@GuillaumeGomez
Rollup merge of rust-lang#77979 - GuillaumeGomez:hide-help-button, r=…
16b1a6f 
…jyn514

Hide help button on mobile

Addresses rust-lang#77899.

This PR is just a quick fix for now: we're still debating about whether or not we want to display this help popup and if so, how. I'll open an issue once this PR is merged to discuss about it.

Before:

![Screenshot from 2020-10-15 17-56-39](https://user-images.githubusercontent.com/3050060/96155127-df499680-0f0f-11eb-8a13-77c537141f21.png)

After:

![Screenshot from 2020-10-15 17-55-06](https://user-images.githubusercontent.com/3050060/96154957-ac070780-0f0f-11eb-9d90-7d8f79a6bf37.png)

r? @jyn514
@jsha
Copy link
Contributor Author

jsha commented May 17, 2021

I propose to close this and consider #77979 the long-term fix. I think hiding the help button on mobile is the right thing to do.

@GuillaumeGomez
Copy link
Member

But that prevents to have access to the search help too, which is why I'm not super happy about it...

@jsha
Copy link
Contributor Author

jsha commented May 18, 2021

Aha, that makes sense.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A-rustdoc-ui Area: rustdoc UI (generated HTML) C-bug Category: This is a bug. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
5 participants
@Nemo157 @jsha @Manishearth @GuillaumeGomez @jyn514