| # References |
| |
| There are many great `rustdoc` references out there. |
| If you know of other great resources, please submit a pull request! |
| |
| ## Official |
| |
| - [Learn Rust] |
| - [Rust By Example] |
| - [Rust Reference] |
| - [RFC 1574: More API Documentation Conventions] |
| - [RFC 1946: Intra Rustdoc Links] |
| |
| ## Community |
| - [API Guidelines] |
| - [GitHub tagged RFCs] |
| - [GitHub tagged issues] |
| - [RFC (stalled) front page styleguide] |
| - [Guide on how to write documentation for a Rust crate] |
| |
| |
| [API Guidelines]: https://rust-lang.github.io/api-guidelines/documentation.html |
| [GitHub tagged RFCs]: https://github.com/rust-lang/rfcs/issues?q=label%3AT-rustdoc |
| [GitHub tagged issues]: https://github.com/rust-lang/rust/issues?q=is%3Aissue+is%3Aopen+label%3AT-rustdoc |
| [Guide on how to write documentation for a Rust crate]: https://blog.guillaume-gomez.fr/articles/2020-03-12+Guide+on+how+to+write+documentation+for+a+Rust+crate |
| [Learn Rust]: https://doc.rust-lang.org/book/ch14-02-publishing-to-crates-io.html#making-useful-documentation-comments |
| [RFC 1574: More API Documentation Conventions]: https://rust-lang.github.io/rfcs/1574-more-api-documentation-conventions.html |
| [RFC 1946: Intra Rustdoc Links]: https://rust-lang.github.io/rfcs/1946-intra-rustdoc-links.html |
| [RFC (stalled) front page styleguide]: https://github.com/rust-lang/rfcs/pull/1687 |
| [Rust By Example]: https://doc.rust-lang.org/stable/rust-by-example/meta/doc.html |
| [Rust Reference]: https://doc.rust-lang.org/stable/reference/comments.html#doc-comments |
