Skip to content

Add a rustdoc user guide to https://doc.rust-lang.org/rustdoc #90309

Closed
@jyn514

Description

@jyn514

Right now, https://doc.rust-lang.org/rustdoc is mostly developer-oriented, it has lots of info about how to use rustdoc the tool but not how to use the generated docs. We should add a user-focused page to it that mentions options people don't usually know about, e.g.

  • ? for search tips
  • the "In Parameters" and "In Return Types" tab of search
  • the settings page maybe?

Metadata

Metadata

Assignees

No one assigned

    Labels

    A-docsArea: Documentation for any part of the project, including the compiler, standard library, and toolsA-rustdoc-uiArea: Rustdoc UI (generated HTML)E-easyCall for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue.E-help-wantedCall for participation: Help is requested to fix this 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

    No branches or pull requests

    Issue actions