From afb0da4bd62522611c1f546df1709e57aac3e7aa Mon Sep 17 00:00:00 2001 From: Ruslan Semagin Date: Fri, 5 Jul 2024 11:49:40 +0300 Subject: [PATCH] link to article 'How to write documentation' in 'Rust' (#6058) --- src/data/roadmaps/rust/content/121-rustdoc.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/src/data/roadmaps/rust/content/121-rustdoc.md b/src/data/roadmaps/rust/content/121-rustdoc.md index b5cbc39d3..7888b5eac 100644 --- a/src/data/roadmaps/rust/content/121-rustdoc.md +++ b/src/data/roadmaps/rust/content/121-rustdoc.md @@ -1,3 +1,7 @@ # Documenting with `rustdoc` -`rustdoc` is a tool that comes bundled with Rust by default. It is primarily used to generate documentation for Rust projects. `rustdoc` takes into consideration both the comments and the source code to produce comprehensive documentation. The resultant documentation can be viewed through a web server or a web browser. The uniqueness of `rustdoc` lies in its testing feature. It can test the code snippets present in your documentation, ensuring that your examples are accurate and up-to-date. It is the de facto tool for all Rust developers to create and maintain their project documentation. \ No newline at end of file +`rustdoc` is a tool that comes bundled with Rust by default. It is primarily used to generate documentation for Rust projects. `rustdoc` takes into consideration both the comments and the source code to produce comprehensive documentation. The resultant documentation can be viewed through a web server or a web browser. The uniqueness of `rustdoc` lies in its testing feature. It can test the code snippets present in your documentation, ensuring that your examples are accurate and up-to-date. It is the de facto tool for all Rust developers to create and maintain their project documentation. + +Visit the following resources to learn more: + +- [@article@How to write documentation](https://doc.rust-lang.org/rustdoc/how-to-write-documentation.html)