Write a "Clippy book"?

[Manishearth]

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

[phansch]

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.

[ebroto]

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.

[flip1995]

I think we could also integrate the documentation about hacking on Clippy, maybe in a different book?

This should definitely be in a different book (clippy-dev-guide?). But since we already have the doc folder for this, this is lower prio.

Regarding infra: we kind of already have this in the remark check, but we need to add a CD pipeline to it (extending the deploy script?).

[moaz-mokhtar]

Hello all,

I'm ready for that. Guide me to getting started.

[flip1995]

The first step would be to set up mdbook in the Clippy repo and on CI. After that, the README should be transferred to the book.

[joshrotenberg]

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