@@ -16,6 +16,10 @@ Create a "Rust Bookshelf" of learning resources for Rust.
16
16
* Provide a path forward for more long-form documentation to be maintained by
17
17
the project.
18
18
19
+ This is largely about how doc.rust-lang.org is organized; today, it points to
20
+ the book, the reference, the nomicon, the error index, and the standard library
21
+ docs. This suggests unifying the first three into one thing.
22
+
19
23
# Motivation
20
24
[ motivation ] : #motivation
21
25
@@ -39,17 +43,20 @@ Several new repositories will be made, one for each of:
39
43
* The Cargo Book
40
44
* The Rust Reference Manual
41
45
46
+ These would live under the ` rust-lang ` organization.
47
+
42
48
They will all use mdBook to build. They will have their existing text re-worked
43
49
into the format; at first a simple conversion, then more major improvements.
44
- Their currnet text will be removed from the main tree.
50
+ Their current text will be removed from the main tree.
45
51
46
52
The first edition of the book lives in-tree, but the second edition lives in
47
53
` rust-lang/book ` . We'll remove the existing text from the tree and move it
48
54
into ` rust-lang/book ` .
49
55
50
- A new book will be created from the "Nightly Rust" section of the book. It
51
- will be called "The Nightly Book," and will contain unstable documentation.
52
- This came up when [ trying to document RFC
56
+ A new book will be created from the "Nightly Rust" section of the book. It will
57
+ be called "The Nightly Book," and will contain unstable documentation for both
58
+ rustc and Cargo, as well as material that will end up in the reference. This
59
+ came up when [ trying to document RFC
53
60
1623] ( https://github.com/rust-lang/rust/pull/37928 ) . We don't have a unified
54
61
way of handling unstable documentation. This will give it a place to develop,
55
62
and part of the stabilization process will be moving documentation from this
@@ -59,6 +66,12 @@ The nightly book will be organized around `#![feature]`s, so that you can look
59
66
up the documentation for each feature, as well as seeing which features
60
67
currently exist.
61
68
69
+ The nightly book is in-tree so that it runs more often, as part of people's
70
+ normal test suite. This doesn't mean that the book won't run on every commit;
71
+ just that the out-of-tree books will run mostly in CI, whereas the nightly
72
+ book will run when developers do ` x.py check ` . This is similar to how, today,
73
+ Traivs runs a subset of the tests, but buildbot runs all of them.
74
+
62
75
The landing page on doc.rust-lang.org will show off the full bookshelf, to let
63
76
people find the documenation they need. It will also link to their respective
64
77
repositories.
@@ -93,6 +106,9 @@ Do nothing.
93
106
94
107
Do only one part of this, instead of the whole thing.
95
108
109
+ Move all of the "bookshelf" into one repository, rather than individual ones.
110
+ This would require a lot more label-wrangling, but might be easier.
111
+
96
112
# Unresolved questions
97
113
[ unresolved ] : #unresolved-questions
98
114
0 commit comments