Skip to content

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

Closed

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?

Activity

  1. added
    T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.
    A-docsArea: Documentation for any part of the project, including the compiler, standard library, and tools
    A-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.
    on Oct 26, 2021
  2. NoraCodes commented on Nov 1, 2021

    @NoraCodes
    Contributor

    Throwing my hat in the ring on this one. Let me know if you'd like me to add some docs for the settings page!

  3. added 2 commits that reference this issue on Nov 6, 2021
  4. jyn514 commented on Nov 30, 2021

    @jyn514
    MemberAuthor

    This was added in #90487; thanks @NoraCodes !

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-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