Skip to content

Commit dce33e9

Browse files
committed
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
1 parent 15ce540 commit dce33e9

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

src/doc/index.md

+9-4
Original file line numberDiff line numberDiff line change
@@ -32,16 +32,21 @@ nicknamed 'The Rust Bookshelf.'
3232
* [The Rustonomicon][nomicon] is your guidebook to the dark arts of unsafe Rust.
3333
* [The Reference][ref] is not a formal spec, but is more detailed and comprehensive than the book.
3434

35+
Initially, documentation lands in the Unstable Book, and then, as part of the
36+
stabilization process, is moved into the Book, Nomicon, or Reference.
37+
3538
Another few words about the reference: it is guaranteed to be accurate, but not
36-
complete. We now have a policy that all new features must be included in the
37-
reference before stabilization; however, we are still back-filling things that
38-
landed before then. That work is being tracked [here][38643].
39+
complete. We have a policy that features must have documentation to be stabilized,
40+
but we did not always have this policy, and so there are some stable things that
41+
are not yet in the reference. We're working on back-filling things that landed
42+
before this policy was put into place. That work is being tracked
43+
[here][refchecklist].
3944

4045
[Rust Learning]: https://github.com/ctjhoa/rust-learning
4146
[Docs.rs]: https://docs.rs/
4247
[api]: std/index.html
4348
[ref]: reference/index.html
44-
[38643]: https://github.com/rust-lang/rust/issues/38643
49+
[refchecklist]: https://github.com/rust-lang-nursery/reference/issues/9
4550
[err]: error-index.html
4651
[book]: book/index.html
4752
[nomicon]: nomicon/index.html

0 commit comments

Comments
 (0)