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: Improve the navigation experience #53961

Open
ishitatsuyuki opened this issue Sep 5, 2018 · 1 comment
Open

rustdoc: Improve the navigation experience #53961

ishitatsuyuki opened this issue Sep 5, 2018 · 1 comment
Labels
A-rustdoc-ui Area: Rustdoc UI (generated HTML) C-enhancement Category: An issue proposing an enhancement or a PR with one. T-rustdoc-frontend Relevant to the rustdoc-frontend team, which will review and decide on the web UI/UX output.

Comments

@ishitatsuyuki
Copy link
Contributor

In the current situation, users navigates either with links from the overview, or by collapsing all descriptions and searching through what they want.

They both have their own problems:
screenshot_2018-09-05 std option option - rust

And I often resort to "Find in page" which is bad on accuracy.

We need a better navigation system, and in either way we should ditch the collapse feature. I have two ways in mind:

  • Use a right sidebar. Sidebar allows you to collapse things by group not per item. It also has a smaller font size, allowing more items to fit in the screen.
  • Make the brief link to everything available in the page. Rust pseudocode is easier to read for some people (including me).

To compare these two approaches, sidebar is more suitable for continuously navigating items without caring the backstack, while the brief is more like "navigate, read, back, navigate, read, back".

Related: #39952

@GuillaumeGomez
Copy link
Member

We don't have enough space available for a second sidebar. Also, I'm not sure what you proposed is better than the current version. To be clear: I agree on the fact that some UI refactoring would be welcome, but those ones aren't convincing me...

@Centril Centril added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Sep 7, 2018
@QuietMisdreavus QuietMisdreavus added the A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools label Nov 6, 2018
@steveklabnik steveklabnik removed the A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools label Dec 27, 2018
@lolbinarycat lolbinarycat added C-enhancement Category: An issue proposing an enhancement or a PR with one. 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. and removed T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. labels Nov 15, 2024
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-enhancement Category: An issue proposing an enhancement or a PR with one. T-rustdoc-frontend Relevant to the rustdoc-frontend team, which will review and decide on the web UI/UX output.
Projects
None yet
Development

No branches or pull requests

6 participants