@@ -39,8 +39,8 @@ upon. Ideally entries in the glossary link to the associated documentation.
39
39
## Adding Documentation
40
40
41
41
There are a lot of features that are not documented at all or are documented
42
- poorly. This is the hardest, but definitely most valuable. Pick something from
43
- [ "Document all features" ] [ 9 ] or a [ missing feature ] tag , and write about it.
42
+ poorly. This is the hardest, but definitely most valuable. Pick an unassigned
43
+ issue from the [ issue tracker ] , and write about it.
44
44
45
45
While writing, you may find it handy to have a [ playpen] open to test out what
46
46
you are documenting.
@@ -50,47 +50,20 @@ appropriate.
50
50
51
51
Note that we don't write documentation for purely library features such as
52
52
threads and IO and we don't write about Rust in the future. Documentation is
53
- written as if the current stable release of Rust is the last release. If you
54
- want to write about Rust in the future, you want [ the Unstable book] [ unstable ] .
55
-
56
- ## RFC Review Process
57
-
58
- Older, stable RFCs need review to determine if they need documentation written
59
- and, if so, need that documentation written. The [ "Document all features"] [ 9 ]
60
- issue tracks the overall effort, and individual RFCs are laid out on the [ RFC
61
- Status] project. RFCs that have not yet been reviewed to scope out the work are
62
- in the "Needs Review" column, with ones needing documentation in the "Stable,
63
- Needs Documentation" column.
64
-
65
- If you review an RFC and determine that there is no documentation required,
66
- please convert the project card to an issue and then close the issue, explaining
67
- why no documentation is required. This is so as to ensure that there is a record
68
- and a chance for others to disagree. If you review it and determine
69
- documentation is necessary, feel free to simply move the card into the "Stable,
70
- Needs Documentation" column. It can be converted into an issue if it needs
71
- discussion, or left as a text card.
72
-
73
- For RFCs which do not stabilize all at once (for instance, because some aspects
74
- are insta-stable), if there is any unstabilized part that needs documentation,
75
- then the RFC should be advanced to "Stable, Needs Documentation" and converted
76
- to an issue. On the issue, remark about which parts need documentation and which
77
- are still unstable.
53
+ written as if the current stable release of Rust is the last release. The
54
+ ` master ` branch of the reference corresponds to what is ** stable** on the
55
+ ` master ` branch ("nightly") of [ rust-lang/rust] . If you want to write about
56
+ Rust in the future, you want [ the Unstable book] [ unstable ] .
78
57
79
58
## Stabilization
80
59
81
- Now, in order for a new RFC to be stabilized, it must have documentation
82
- written. If this requires a change to the reference, then the necessary
83
- documentation should be written and a PR created. Once the PR has been reviewed
84
- (along with any necessary documentation PRs to other repositories), the feature
85
- can be stabilized in Rust, and then the doc PRs merged. Anyone is free to write
86
- these PRs, but they should wait until the feature is unlikely to change much
87
- before stabilization.
60
+ When something that alters the language is stabilized, an issue should be
61
+ opened on the reference [ issue tracker] to track the documentation process.
62
+ This should include links to any relevant information, such as the
63
+ stabilization PR, the RFC, the tracking issue, and anything else that would be
64
+ helpful for writing the documentation.
88
65
89
- RFCs needed documentation for stabilization can be added to the [ RFC Status]
90
- project, under the "Awaiting Docs for Stabilization" column.
91
-
92
- [ 9 ] : https://github.com/rust-lang-nursery/reference/issues/9
93
- [ missing feature ] : https://github.com/rust-lang-nursery/reference/issues?q=is%3Aissue+is%3Aopen+label%3A%22Missing+Feature%22
66
+ [ issue tracker ] : https://github.com/rust-lang-nursery/reference/issues
94
67
[ playpen ] : https://play.rust-lang.org/
68
+ [ rust-lang/rust ] : https://github.com/rust-lang/rust/
95
69
[ unstable ] : https://doc.rust-lang.org/nightly/unstable-book/
96
- [ RFC Status ] : https://github.com/rust-lang-nursery/reference/projects/1
0 commit comments