summaryrefslogtreecommitdiffstats
path: root/src/doc/rustdoc/src/SUMMARY.md
diff options
context:
space:
mode:
Diffstat (limited to 'src/doc/rustdoc/src/SUMMARY.md')
-rw-r--r--src/doc/rustdoc/src/SUMMARY.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/src/doc/rustdoc/src/SUMMARY.md b/src/doc/rustdoc/src/SUMMARY.md
new file mode 100644
index 000000000..747cc629b
--- /dev/null
+++ b/src/doc/rustdoc/src/SUMMARY.md
@@ -0,0 +1,16 @@
+# The Rustdoc Book
+
+- [What is rustdoc?](what-is-rustdoc.md)
+- [Command-line arguments](command-line-arguments.md)
+- [How to read rustdoc output](how-to-read-rustdoc.md)
+- [How to write documentation](how-to-write-documentation.md)
+ - [What to include (and exclude)](write-documentation/what-to-include.md)
+ - [The `#[doc]` attribute](write-documentation/the-doc-attribute.md)
+ - [Linking to items by name](write-documentation/linking-to-items-by-name.md)
+ - [Documentation tests](write-documentation/documentation-tests.md)
+- [Rustdoc-specific lints](lints.md)
+- [Scraped examples](scraped-examples.md)
+- [Advanced features](advanced-features.md)
+- [Unstable features](unstable-features.md)
+- [Deprecated features](deprecated-features.md)
+- [References](references.md)