Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove Unstable Documentation #119

Closed
Havvy opened this issue Sep 24, 2017 · 6 comments
Closed

Remove Unstable Documentation #119

Havvy opened this issue Sep 24, 2017 · 6 comments
Labels
C-bug Incorrect statements, terminology, or rendering issues Easy We believe this would not be difficult to actually fix Help Wanted Tracking Issue

Comments

@Havvy
Copy link
Contributor

Havvy commented Sep 24, 2017

As per #111, we don't yet have a story on whether we want to document unstable aspects of Rust, and if we do, how do we want to do so?

@Havvy Havvy added the C-discussion Request for comments about the direction of the reference label Sep 24, 2017
@brauliobz
Copy link
Contributor

The Unstable Book seems to be the correct place to put unstable things. It is also in a better format for this kind of thing, in my opinion.

@Havvy
Copy link
Contributor Author

Havvy commented Sep 30, 2017

I concur with @brauliobz that unstable features should be documented primarily in the Unstable Book. This would make the reference primarily about stable features in the language and we'd merge in what's in the Unstable Book when a feature is stabilized. We would then add information to the introduction stating it's only documenting what is available in stable rust.

Right now there are unstable features documented in the reference. There's even a PR (#111) to remove one instance of it. I want to merge it, but also have the commented out portion on how to change when it stabilizes be located in the Unstable Book.

Do we need an RFC to make this policy change? Or would consensus in a docs meeting be good enough? Or something else?

@QuietMisdreavus
Copy link
Member

In principle i agree - now that the Unstable Book exists, things that are unstable belong there, by definition. I don't recall whether official policy was made on moving existing docs on unstable things to the Unstable Book (standard library documentation notwithstanding). I've added this to the agenda for the next docs team meeting so we can double-check this.

@steveklabnik
Copy link
Member

We did do that with the Book v1...

@steveklabnik
Copy link
Member

Talked about it at the docs team. We're basically all in agreement: only stable stuff should go in the reference. Moving the unstable stuff to the unstable book is good. Let's keep this issue open to track that, as well as actually stating this somewhere in the text.

@Havvy
Copy link
Contributor Author

Havvy commented Oct 11, 2017

Yay. I'll update the issue when I get home and write a PR for the front page.

@Havvy Havvy changed the title Determine How/If to document Unstable things Remove Unstable Documentation Oct 12, 2017
@Havvy Havvy added C-bug Incorrect statements, terminology, or rendering issues Easy We believe this would not be difficult to actually fix Help Wanted Tracking Issue and removed C-discussion Request for comments about the direction of the reference labels Oct 12, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-bug Incorrect statements, terminology, or rendering issues Easy We believe this would not be difficult to actually fix Help Wanted Tracking Issue
Projects
None yet
Development

No branches or pull requests

4 participants