Need Rust docs on protocols::v2::noise-sv2

[rrybarczyk]

Background

Currently, the protocols::v2::noise-sv2 logic does not contain any in-line rust documentation, resulting in no documentation on its crates.io site.

Note: While this issue addresses the need for doc comments, it will also serve as a means to identify code debt that needs to be cleaned up and addressed in future issues.

Problem

When a user navigates to this crate crates.io, there is no useful information for the user. This impedes understanding and adoption.

Solution

Navigate through each crate in protocols::v2::noise-sv2 and add:

• Rust Docs comments (following the formatting structure in this on-going discussion), to be displayed in docs.rs
• a descriptive README.md file to be displayed in crates.io

While this work is being performed, specific code debt should be looked for and recorded to turn into future issues

[Shourya742]

Can I take this up?

[Fi3]

I don't understand if the issue is about the readme.md file (what is showed in crates.io) or code comments (what is showed in the docs.rs) or maybe both, I think that we should make it clear

[plebhash]

I don't understand if the issue is about the readme.md file (what is showed in crates.io) or code comments (what is showed in the docs.rs) or maybe both, I think that we should make it clear

it makes sense to write both... I'll edit the issue description to reflect this