rust-lang / rust-lang/docs.rs

mobile: move topbar into sidebar

Open
#1,598 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
1.2k
Forks
232
Avg merge
11h 35m
Merged PRs (30d)
60

Description

Right now the mobile UI looks like this:

The icons are out of scale with the hamburger icon, and in a different color. Also, the icons don't clearly map to meanings - for instance, people don't look at "leaf" and realize that means "releases."


And when you click on a method in the sidebar it looks like this:

The hamburger icon partially covers the text that you want to see. I'm planning to fix that in rust-lang/rust#92692 by making rustdoc's whole topbar sticky, not just the hamburger icon. But then we'll have double topbars the whole time you're scrolling the page.

I propose that instead of having a docs.rs topbar on mobile, we should move the topbar items into the rustdoc sidebar menu, under the hamburger icon. There we'll have room to write out the text for each item, so it's clearer what they are. And we won't have to have two topbars. It could look something like this:

Replacer

docs.rs

regex 1.3.1
Platform
Feature flags
Releases

Thoughts?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by inspecting the docs.rs mobile topbar and the rustdoc sidebar menu, including the related rust-lang/rust#92692 change. Done means the mobile sidebar contains clearly labeled topbar items, the separate docs.rs topbar is removed, and the hamburger no longer obscures page text.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
design, frontend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.