Skip to content

Commit 91bd051

Browse files
committed
update with details
1 parent b616749 commit 91bd051

File tree

1 file changed

+20
-4
lines changed

1 file changed

+20
-4
lines changed

text/0000-rust-bookshelf.md

+20-4
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,10 @@ Create a "Rust Bookshelf" of learning resources for Rust.
1616
* Provide a path forward for more long-form documentation to be maintained by
1717
the project.
1818

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+
1923
# Motivation
2024
[motivation]: #motivation
2125

@@ -39,17 +43,20 @@ Several new repositories will be made, one for each of:
3943
* The Cargo Book
4044
* The Rust Reference Manual
4145

46+
These would live under the `rust-lang` organization.
47+
4248
They will all use mdBook to build. They will have their existing text re-worked
4349
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.
4551

4652
The first edition of the book lives in-tree, but the second edition lives in
4753
`rust-lang/book`. We'll remove the existing text from the tree and move it
4854
into `rust-lang/book`.
4955

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
5360
1623](https://github.com/rust-lang/rust/pull/37928). We don't have a unified
5461
way of handling unstable documentation. This will give it a place to develop,
5562
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
5966
up the documentation for each feature, as well as seeing which features
6067
currently exist.
6168

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+
6275
The landing page on doc.rust-lang.org will show off the full bookshelf, to let
6376
people find the documenation they need. It will also link to their respective
6477
repositories.
@@ -93,6 +106,9 @@ Do nothing.
93106

94107
Do only one part of this, instead of the whole thing.
95108

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+
96112
# Unresolved questions
97113
[unresolved]: #unresolved-questions
98114

0 commit comments

Comments
 (0)