about summary refs log tree commit diff
path: root/src/doc/index.md
diff options
context:
space:
mode:
authorsteveklabnik <steve@steveklabnik.com>2017-04-25 05:35:51 -0400
committersteveklabnik <steve@steveklabnik.com>2017-04-25 05:35:51 -0400
commitdce33e96bc2f904fbc5bfb96b5fb92433dc18ba8 (patch)
tree01a68dfc6016acb2cc87e24f9763434b2e5de99c /src/doc/index.md
parent15ce54096a589de277771ad1f55a334fe2661a64 (diff)
downloadrust-dce33e96bc2f904fbc5bfb96b5fb92433dc18ba8.tar.gz
rust-dce33e96bc2f904fbc5bfb96b5fb92433dc18ba8.zip
Clarify the doc index
With regards to the unstable book, the reference, and the
processes involved.

Also, fix up a link by pointing to the new tracking issue rather than
the older one.

Fixes #41285
Diffstat (limited to 'src/doc/index.md')
-rw-r--r--src/doc/index.md13
1 files changed, 9 insertions, 4 deletions
diff --git a/src/doc/index.md b/src/doc/index.md
index 1294c1a8c59..fd5b120e81f 100644
--- a/src/doc/index.md
+++ b/src/doc/index.md
@@ -32,16 +32,21 @@ nicknamed 'The Rust Bookshelf.'
 * [The Rustonomicon][nomicon] is your guidebook to the dark arts of unsafe Rust.
 * [The Reference][ref] is not a formal spec, but is more detailed and comprehensive than the book.
 
+Initially, documentation lands in the Unstable Book, and then, as part of the
+stabilization process, is moved into the Book, Nomicon, or Reference.
+
 Another few words about the reference: it is guaranteed to be accurate, but not
-complete. We now have a policy that all new features must be included in the
-reference before stabilization; however, we are still back-filling things that
-landed before then. That work is being tracked [here][38643].
+complete. We have a policy that features must have documentation to be stabilized,
+but we did not always have this policy, and so there are some stable things that
+are not yet in the reference. We're working on back-filling things that landed
+before this policy was put into place. That work is being tracked
+[here][refchecklist].
 
 [Rust Learning]: https://github.com/ctjhoa/rust-learning
 [Docs.rs]: https://docs.rs/
 [api]: std/index.html
 [ref]: reference/index.html
-[38643]: https://github.com/rust-lang/rust/issues/38643
+[refchecklist]: https://github.com/rust-lang-nursery/reference/issues/9
 [err]: error-index.html
 [book]: book/index.html
 [nomicon]: nomicon/index.html