search

rust-lang / spec

The Rust specification
Apache License 2.0
103 stars 7 forks source link

Should there be a warning about being incomplete? #41

Open ehuss opened 8 months ago

ehuss commented 8 months ago

Should the rendered pages have a warning about being incomplete or being a draft status for now?

https://github.com/rust-lang/reference/commit/0ff74931d51f824996e2c9586fef7ef745f0254a is an example of how to implement that.

JoelMarcey commented 8 months ago

So all pages have that warning by default, I presume. I am fine if we want to do that. Whether we do it now or start after we complete the first version / iteration of the spec - I have no strong feelings. For the work we are doing now, most everything is going to be in draft status, so the warnings may be overkill at this point. But, like I said, no strong feeings.

ehuss commented 8 months ago

I think people found the warning on every page in the reference annoying and unhelpful (and misleading).

We left only a single warning on the front page: https://doc.rust-lang.org/nightly/reference/. I would probably recommend just mentioning the draft status somehow on the front page.