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

Should there be a warning about being incomplete? #41

Open
ehuss opened this issue Mar 1, 2024 · 2 comments
Open

Should there be a warning about being incomplete? #41

ehuss opened this issue Mar 1, 2024 · 2 comments
Labels
C-tooling Category: Discussion/Changes related to custom mdbook tooling

Comments

@ehuss
Copy link
Contributor

ehuss commented Mar 1, 2024

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

rust-lang/reference@0ff7493 is an example of how to implement that.

@JoelMarcey
Copy link
Contributor

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
Copy link
Contributor Author

ehuss commented Mar 6, 2024

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.

@JoelMarcey JoelMarcey added the C-tooling Category: Discussion/Changes related to custom mdbook tooling label Mar 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-tooling Category: Discussion/Changes related to custom mdbook tooling
Projects
Development

No branches or pull requests

2 participants