Write a "Clippy book"? #6011
Comments
|
Seems like a good idea - We could even go as far as including the lint documentation in the book. If the book is then bundled with rustup, like the other books, the lint docs would be available offline as well. |
|
I'm on board. I think we could also integrate the documentation about hacking on Clippy, maybe in a different book? I'm not familiar with creating those books, but I guess we will need a test in CI to check that the book is generated correctly, so I'll add the infrastructure tag. |
ebroto
added
the
A-infra
This should definitely be in a different book (clippy-dev-guide?). But since we already have the Regarding infra: we kind of already have this in the |
phansch
added
the
E-help-wanted
|
Hello all, I'm ready for that. Guide me to getting started. |
|
The first step would be to set up |
|
It looks like maybe the previous effort on this has stalled. I took a fresh crack at an outline with some lifted content and a big lists of questions on how to proceed: #7359 |
Clippy book A work in progress Clippy Book using mdbook. See #6011. This is currently just a moving around of things: 1. The current README.md split up a bit and put into sections. 1. A rough outline of Clippy lint categories (currently no content, potentially add a basic introduction for each and some example, see questions below. 1. The `docs` content repurposed into a top level `Development` section. 1. The current Roadmap. Some big questions: 1. is `guide/` the right place? I'm modeling after mdbook itself. 1. What is the relationship between ALL the Clippy Lints and this guide? It seems like they can coexist. Does that mean the guide should just point to the current side with regard to actual lints, and maybe just include some examples to keep it interesting? Keeping both up to date seems like a maintenance nightmare unless its automated somehow. Or should the current ALL the Clippy lints somehow be incorporated into the book? 1. Related to the above, where should this guide be published since the `gh-pages` branch is already in use? 1. This PR doesn't currently change any existing content. Obviously that would make sense assuming the general structure and relocation is an acceptable approach. --- Open Tasks for follow up PR: - Set up CI/CD - Split up Installation and Usage - Add more content to Usage (and Installation) chapters - Enhance CI chapter with more examples for different CIs
Clippy book A work in progress Clippy Book using mdbook. See #6011. This is currently just a moving around of things: 1. The current README.md split up a bit and put into sections. 1. A rough outline of Clippy lint categories (currently no content, potentially add a basic introduction for each and some example, see questions below. 1. The `docs` content repurposed into a top level `Development` section. 1. The current Roadmap. Some big questions: 1. is `guide/` the right place? I'm modeling after mdbook itself. 1. What is the relationship between ALL the Clippy Lints and this guide? It seems like they can coexist. Does that mean the guide should just point to the current side with regard to actual lints, and maybe just include some examples to keep it interesting? Keeping both up to date seems like a maintenance nightmare unless its automated somehow. Or should the current ALL the Clippy lints somehow be incorporated into the book? 1. Related to the above, where should this guide be published since the `gh-pages` branch is already in use? 1. This PR doesn't currently change any existing content. Obviously that would make sense assuming the general structure and relocation is an acceptable approach. --- Open Tasks for follow up PR: - Set up CI/CD - Split up Installation and Usage - Add more content to Usage (and Installation) chapters - Enhance CI chapter with more examples for different CIs --- changelog: The first version of the *Clippy Book* staring, *The Clippy Team*, *Bors* and *rustc*
and others
Rustdoc has a really nice short book with a lot of the features explained: https://doc.rust-lang.org/rustdoc/
Perhaps we should do the same thing? We coudl then link it from the Rust website and might have fewer discoverability problems.
cc @rust-lang/clippy
The text was updated successfully, but these errors were encountered: