Full documentation coverage on public items

[xJonathanLEI]

There's currently very little documentation. We need to:

• [ ] achieve full doc coverage on all public items on all crates
• [ ] add #![deny(missing_docs)] to all crates to enforce documentation

[xJonathanLEI]

Maybe use ChatGPT to help with this?

[omarespejel]

I would love to work on this. Any particular pattern/format you would want to follow for the documentation?

[xJonathanLEI]

Thanks @omarespejel! I guess it's best to follow existing items that already have some docs. e.g.

https://github.com/xJonathanLEI/starknet-rs/blob/f7cc49ea99aaccbfb2465fe8fb665bdff21da044/starknet-ff/src/lib.rs#L147-L156

[omarespejel]

Makes sense! Thank you @xJonathanLEI.

[xJonathanLEI]

Basic documentation now exists for all crates. The docs are by no means extensive. In most cases they're just basic description of what the type/method does, without giving code examples. Nevertheless, this issue should now be considered completed.