Skip to content

rustdoc: linkify "Structs", "Traits", etc., in sidebar #92957

Closed
@jsha

Description

@jsha
Contributor

In rustdoc sidebars, most headings are clickable links. For instance, "Required Methods" and "Implementors" in the sidebar of https://doc.rust-lang.org/nightly/std/string/trait.ToString.html.

However, the headings under "Other items in..." are not clickable. We should link those to the appropriate subheading on the module page. That allows the user to see a more verbose listing of items in the module, since each one has a description alongside it.

Activity

added
E-easyCall for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue.
T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.
A-rustdoc-uiArea: Rustdoc UI (generated HTML)
on Jan 16, 2022
TmLev

TmLev commented on Jan 17, 2022

@TmLev
Contributor

So, for instance, sidebar heading Structs should lead here?

chansuke

chansuke commented on Jan 17, 2022

@chansuke
Contributor

@rustbot claim

jsha

jsha commented on Jan 17, 2022

@jsha
ContributorAuthor

So, for instance, sidebar heading Structs should lead here?

Yes, that's correct.

jsha

jsha commented on Jan 21, 2022

@jsha
ContributorAuthor

By the way @chansuke be aware this will conflict with #92660. Resolving the conflict should be pretty easy though.

chansuke

chansuke commented on Jan 22, 2022

@chansuke
Contributor

@jsha Thanks

jsha

jsha commented on Jan 31, 2022

@jsha
ContributorAuthor

@chansuke any progress on this? I'd like to get it landed before the beta cut, so we have a consistent UI where headings in the sidebar are clickable.

chansuke

chansuke commented on Jan 31, 2022

@chansuke
Contributor

@jsha sorry, i couldn't make time last week.ok,i will unassign me, thanks.

removed their assignment
on Jan 31, 2022
added a commit that references this issue on Feb 7, 2022

Rollup merge of rust-lang#93673 - jsha:linkify-sidebar-headings, r=Gu…

3ad5779

3 remaining items

Loading
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    A-rustdoc-uiArea: Rustdoc UI (generated HTML)E-easyCall for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue.T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

      Development

      Participants

      @jsha@chansuke@TmLev

      Issue actions

        rustdoc: linkify "Structs", "Traits", etc., in sidebar · Issue #92957 · rust-lang/rust