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

Put the workspace crates first in the side panel #85759

Open
Boiethios opened this issue May 27, 2021 · 2 comments
Open

Put the workspace crates first in the side panel #85759

Boiethios opened this issue May 27, 2021 · 2 comments
Labels
A-rustdoc-ui Area: rustdoc UI (generated HTML) C-feature-request Category: A feature request, i.e: not implemented / a PR. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@Boiethios
Copy link

Describe the problem you are trying to solve

I try to document a project with a few crates in a workspace. The issue is that there is a ton of dependencies (that I'd like to browse when needed), and my crates are drowned in the middle of those dependencies in the side panel.

It's impossible to see in a glance which crates are in the project, and thus to browse the project correctly.

Describe the solution you'd like

I think that the crates from the workspace should come first if the side panel, and then the dependencies. If there are 2 crates foo and bar in the workspace, the panel should looks like that:

CRATES
---------
bar
foo
---------
all
the
dependencies
@ehuss ehuss transferred this issue from rust-lang/cargo May 27, 2021
@ehuss
Copy link
Contributor

ehuss commented May 27, 2021

Transferred to rust-lang/rust, as that is where rustdoc lives.

Also, this is somewhat similar to #16328 and #81031.

@Boiethios
Copy link
Author

Sorry for that: since I type cargo doc to generate the doc, I thought it was a cargo issue.

@LeSeulArtichaut LeSeulArtichaut added C-feature-request Category: A feature request, i.e: not implemented / a PR. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. A-rustdoc-ui Area: rustdoc UI (generated HTML) labels May 28, 2021
@jsha jsha changed the title Put the worspace crates first in the side panel Put the workspace crates first in the side panel Jun 3, 2021
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-feature-request Category: A feature request, i.e: not implemented / a PR. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Development

No branches or pull requests

3 participants