src/doc/rustdoc/src/references.md

   1 # References
   2
   3 There are many great `rustdoc` references out there.
   4 If you know of other great resources, please submit a pull request!
   5
   6 ## Official
   7
   8 - [Learn Rust]
   9 - [Rust By Example]
  10 - [Rust Reference]
  11 - [RFC 1574: More API Documentation Conventions]
  12 - [RFC 1946: Intra Rustdoc Links]
  13
  14 ## Community
  15 - [API Guidelines]
  16 - [Github tagged RFCs]
  17 - [Github tagged issues]
  18 - [RFC (stalled) front page styleguide]
  19 - [Guide on how to write documentation for a Rust crate]
  20
  21
  22 [API Guidelines]: https://rust-lang.github.io/api-guidelines/documentation.html
  23 [Github tagged RFCs]: https://github.com/rust-lang/rfcs/issues?q=label%3AT-rustdoc
  24 [Github tagged issues]: https://github.com/rust-lang/rust/issues?q=is%3Aissue+is%3Aopen+label%3AT-rustdoc
  25 [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
  26 [Learn Rust]: https://doc.rust-lang.org/book/ch14-02-publishing-to-crates-io.html#making-useful-documentation-comments
  27 [RFC 1574: More API Documentation Conventions]: https://rust-lang.github.io/rfcs/1574-more-api-documentation-conventions.html
  28 [RFC 1946: Intra Rustdoc Links]: https://rust-lang.github.io/rfcs/1946-intra-rustdoc-links.html
  29 [RFC (stalled) front page styleguide]: https://github.com/rust-lang/rfcs/pull/1687
  30 [Rust By Example]: https://doc.rust-lang.org/stable/rust-by-example/meta/doc.html
  31 [Rust Reference]: https://doc.rust-lang.org/stable/reference/comments.html#doc-comments