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.

Sign up for GitHub

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

Jump to bottom

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

Closed
jyn514 opened this issue Oct 26, 2021 · 2 comments
Closed

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

jyn514 opened this issue Oct 26, 2021 · 2 comments
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools A-rustdoc-ui Area: Rustdoc UI (generated HTML) E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. E-help-wanted Call for participation: Help is requested to fix this issue. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@jyn514
Copy link
Member

jyn514 commented Oct 26, 2021

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?
@jyn514 jyn514 added T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools A-rustdoc-ui Area: Rustdoc UI (generated HTML) labels Oct 26, 2021
@jyn514 jyn514 mentioned this issue Oct 27, 2021
Closed
@jyn514 jyn514 added E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. E-help-wanted Call for participation: Help is requested to fix this issue. labels Oct 30, 2021
@NoraCodes NoraCodes mentioned this issue Nov 1, 2021
Merged
@NoraCodes
Copy link
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!

matthiaskrgr added a commit to matthiaskrgr/rust that referenced this issue Nov 6, 2021
@matthiaskrgr
Rollup merge of rust-lang#90487 - NoraCodes:nora/how-to-read-rustdoc,…
dad5a31 
… r=jyn514

Add a chapter on reading Rustdoc output

Includes documentation for:
 - general page structure
 - navigation
 - searching
 - themes
 - deep-linking

Doesn't include docs on the settings page.

Per rust-lang#90309
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this issue Nov 6, 2021
@matthiaskrgr
Rollup merge of rust-lang#90487 - NoraCodes:nora/how-to-read-rustdoc,…
de332b5 
… r=jyn514

Add a chapter on reading Rustdoc output

Includes documentation for:
 - general page structure
 - navigation
 - searching
 - themes
 - deep-linking

Doesn't include docs on the settings page.

Per rust-lang#90309
@jyn514
Copy link
Member Author

jyn514 commented Nov 30, 2021

This was added in #90487; thanks @NoraCodes !

@jyn514 jyn514 closed this as completed Nov 30, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools A-rustdoc-ui Area: Rustdoc UI (generated HTML) E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. E-help-wanted Call for participation: Help is requested to fix this issue. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@NoraCodes @jyn514