[Feature] Better Rust Docs

[gluax]

🚀 Feature

We should have better Rust Docs for Leo and its sub-crates.

Motivation

For clearer developer documentation. We should also set up a GitHub Pages to host the master branch version, for the sake of convenience for developers(it should be free).

We should add the clippy flag #![deny(clippy::all, clippy::missing_docs_in_private_items)] to our rust format configuration so this is enforced.

For now, while this rust cargo issue or this clippy issue is not implemented, we should add that line to each package's lib/entry point file.

Implementation

Go comment on all the things.

• [ ] asg-passes
• [ ] asg
• [ ] ast
• [ ] compiler
• [x] errors
• [ ] examples
• [ ] imports
• [ ] input
• [ ] leo
• [ ] linter
• [ ] package
• [ ] parser
• [ ] state
• [ ] synthesizer
• [ ] test-framework
• [ ] tests

[collinc97]

Marking this as priority low until after testnet3 refactor