Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Open
rrybarczyk opened this issue Jun 26, 2024 · 3 comments · May be fixed by #1111
Open

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

rrybarczyk opened this issue Jun 26, 2024 · 3 comments · May be fixed by #1111
Assignees
@Shourya742
Labels
documentation Improvements or additions to documentation noise-sv2 protocols Lowest level protocol logic
Milestone
1.1.0

Comments

@rrybarczyk
Copy link
Collaborator

rrybarczyk commented Jun 26, 2024 •
edited by plebhash
Loading

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
@rrybarczyk rrybarczyk added documentation Improvements or additions to documentation protocols Lowest level protocol logic noise-sv2 labels Jun 26, 2024
@rrybarczyk rrybarczyk mentioned this issue Jun 26, 2024
Open
67 tasks
@Shourya742
Copy link
Contributor

Can I take this up?

@Fi3
Copy link
Collaborator

Fi3 commented Jul 29, 2024

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
Copy link
Collaborator

plebhash commented Jul 29, 2024 •
edited
Loading

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

@plebhash plebhash assigned plebhash and Shourya742 and unassigned plebhash Jul 29, 2024
@plebhash plebhash linked a pull request Aug 20, 2024 that will close this issue
Rust docs noise_sv2 #1111
Open
@plebhash plebhash added this to the 1.1.0 milestone Aug 20, 2024
@plebhash plebhash linked a pull request Aug 20, 2024 that will close this issue
Open
@rrybarczyk rrybarczyk mentioned this issue Aug 21, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Shourya742 Shourya742

Labels
documentation Improvements or additions to documentation noise-sv2 protocols Lowest level protocol logic
Projects
SV2 Roadmap 🛣️
Status: Ready For Review 🔍
Milestone
1.1.0
Development

Successfully merging a pull request may close this issue.

Rust docs noise_sv2 Shourya742/stratum
4 participants
@Fi3 @rrybarczyk @Shourya742 @plebhash