Skip to content

Add Best-Effort Warning at top of page #118

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

Closed
Havvy opened this issue Sep 22, 2017 · 1 comment
Closed

Add Best-Effort Warning at top of page #118

Havvy opened this issue Sep 22, 2017 · 1 comment
Labels
Enhancement Improvement in a non-prose section of the book

Comments

@Havvy
Copy link
Contributor

Havvy commented Sep 22, 2017

Add a warning to the top of the page detailing that the reference is currently at a best-effort stage, like the warning for the second edition Rust-book (see image).

Text from Rust book 2nd edition with warning class

The text of this warning should contain the following or similar text, but with proper linking:

"For now, the Rust reference is a best-effort document. We strive for validity and completeness, but are not yet there. At some point in the future, the docs and lang team will work together to figure out how best to do this. Until then, this document is a best-effort attempt. If you find something wrong or missing, file an issue or send in a pull request."

@steveklabnik
Copy link
Member

This is implemented here: https://github.com/rust-lang/book/tree/master/second-edition/theme

basically, we'd create a theme directory and then modify that index.hbs

@Havvy Havvy added the Enhancement Improvement in a non-prose section of the book label Sep 24, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Enhancement Improvement in a non-prose section of the book
Projects
None yet
Development

No branches or pull requests

2 participants