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

Add more content into rustdoc book #75521

Closed
GuillaumeGomez opened this issue Aug 14, 2020 · 3 comments · Fixed by #75778
Closed

Add more content into rustdoc book #75521

GuillaumeGomez opened this issue Aug 14, 2020 · 3 comments · Fixed by #75778
Labels
A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@GuillaumeGomez
Copy link
Member

https://doc.rust-lang.org/rustdoc/what-is-rustdoc.html is a very nice introduction, but maybe it's time to go further and provide maybe guidelines, more tips and customization chapters?

@GuillaumeGomez GuillaumeGomez 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 labels Aug 14, 2020
@AndyGauge
Copy link
Contributor

I'm going to begin working on this. Many questions to follow :)

@AndyGauge
Copy link
Contributor

AndyGauge commented Aug 19, 2020

Is this the kind of info we want to see:

Also, I'd love to get an idea what customization can be done, haven't seen that in the wild.

Here's a list of customizations I've found:

  • #[doc(alias="another")]

@AndyGauge
Copy link
Contributor

Got started today on this. Here's a bit of the work:
AndyGauge#1
Is it in the right direction?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants