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: redesign toolbar and disclosure widgets #129545

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Commits on Sep 11, 2024

  1. rustdoc: redesign toolbar and disclosure widgets

    This adds labels to the icons and moves them away from the search box.
    
    These changes are made together, because they work together, but are based on
    several complaints:
    
    * The [+/-] thing are a Reddit-ism. They don't look like buttons, but look
      like syntax
      <https://rust-lang.zulipchat.com/#narrow/stream/266220-t-rustdoc/topic/More.20visual.20difference.20for.20the.20.2B.2F-.20.20Icons>,
      <rust-lang#59851>
      (some of these are laundry lists with more suggestions, but they all
      mention [+/-] looking wrong)
    
    * The settings, help, and summary buttons are also too hard to recognize
      <https://lwn.net/Articles/987070/>,
      <rust-lang#90310>,
      <rust-lang#14475 (comment)>,
      <https://internals.rust-lang.org/t/improve-rustdoc-design/12758>
      ("Not all functionality is self-explanatory, for example the [+] button in
      the top right corner, the theme picker or the settings button.")
    
    The toggle-all and toggle-individual buttons both need done at once, since we
    want them to look like they go together. This changes them from both being
    [+/-] to both being arrows.
    
    Settings and Help are also migrated, so that the whole group can benefit from
    being described using actual words.
    
    Additionally, the Help button is only shown on SERPs, not all the time.
    This is done for two major reasons:
    
    * Most of what's in there is search-related. The things that aren't are
      keyboard commands, and the search box tells you about that anyway.
      Pressing <kbd>?</kbd> will temporarily show the button and its popover.
    * I'm trading it off by showing the help button, even on mobile.
      It's useful since you can use the search engine suggestions there.
    * The three buttons were causing line wrapping on too many desktop layouts.
    notriddle committed Sep 11, 2024
    Configuration menu
    Copy the full SHA
    d05323c View commit details
    Browse the repository at this point in the history
  2. rustdoc: make the header show all three buttons

    This tweaks it to use less space for the breadcrumbs.
    notriddle committed Sep 11, 2024
    Configuration menu
    Copy the full SHA
    5b1b2e9 View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    df307d0 View commit details
    Browse the repository at this point in the history

Commits on Sep 13, 2024

  1. Configuration menu
    Copy the full SHA
    17f5afe View commit details
    Browse the repository at this point in the history

Commits on Sep 22, 2024

  1. Tweak breadcrumbs list

    notriddle committed Sep 22, 2024
    Configuration menu
    Copy the full SHA
    6260680 View commit details
    Browse the repository at this point in the history