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] issues of the three-big-buttons #132386

Open
liigo opened this issue Oct 31, 2024 · 2 comments · May be fixed by #133279
Open

[rustdoc] issues of the three-big-buttons #132386

liigo opened this issue Oct 31, 2024 · 2 comments · May be fixed by #133279
Labels
A-rustdoc-ui Area: Rustdoc UI (generated HTML) C-discussion Category: Discussion or questions that doesn't represent real issues. T-rustdoc-frontend Relevant to the rustdoc-frontend team, which will review and decide on the web UI/UX output.

Comments

@liigo
Copy link
Contributor

liigo commented Oct 31, 2024

PR #129545 introduced a new style for rustdoc API pages.

I appreciate the author's efforts. But the new style still has a few shortcomings.

  • It's not as compact as the old style, more than one line space in vertical is wasted.
  • It does not utilize the horizontal space on search-box's right. (Are we really need a so big search box? as nearly wide as screen?)
  • The icon+text button is unnecessary, there's well known icons for help/setting/folding, no text is needed here.
  • The three-big-buttons may attract user's attention, and distract exploring contents.
  • The top-right version+source are moved to top-left, while leaving most other version+sources at right, that makes a big UX pain.

That PR said:

The settings, help, and summary buttons are also too hard to recognize.

I don't think that's right. Gear-icon for setting, question-mark-icon for help, +/--icon for folding, are widely used all over the world, the meaning is clear. The top-right position of the window is also easy to find and reach. The search box has a tip of '? for more options' in its placehold, you may type ‘?’ key to 'click' the help button. There's document in help page to help you find folding button. That's enough, for those low utilization rate buttons. Folding (aka summary) button's icon may use a different color to improve recogniztion.

That PR made those buttons very big, bigger than any other items of the page. That's an UX issue too (as i said above).

I propose:

  • Make the three-big-buttons smaller, by removing text (and add tooltips), and move them to right of search-box.
  • Move top-left version+source back to top-right (below the new three-icon-buttons).
  • Change color of folding-button's icon to improve its recogniztion.
  • Change order of the new three-icon-buttons: help, setting, folding.
  • Improve help page: to match collapse/expand vs summary/show-all vs folding/unfolding.

links: new style, old style

Image


Image

@rustbot rustbot added the needs-triage This issue may need triage. Remove it if it has been sufficiently triaged. label Oct 31, 2024
@jieyouxu jieyouxu added A-rustdoc-ui Area: Rustdoc UI (generated HTML) T-rustdoc-frontend Relevant to the rustdoc-frontend team, which will review and decide on the web UI/UX output. C-discussion Category: Discussion or questions that doesn't represent real issues. and removed needs-triage This issue may need triage. Remove it if it has been sufficiently triaged. labels Oct 31, 2024
@Urgau
Copy link
Member

Urgau commented Oct 31, 2024

cc @notriddle @GuillaumeGomez

@notriddle
Copy link
Contributor

The settings, help, and summary buttons are also too hard to recognize.

I don't think that's right.

But the PR links to the first- and second-hand reports of several people who didn't recognize them. Here they are again, with quotes extracted from the text this time.

@notriddle notriddle linked a pull request Nov 21, 2024 that will close this issue
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) C-discussion Category: Discussion or questions that doesn't represent real issues. T-rustdoc-frontend Relevant to the rustdoc-frontend team, which will review and decide on the web UI/UX output.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants