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.

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

Document PublicKey #279

Closed
ionut-arm opened this issue Oct 15, 2021 · 6 comments
Closed

Document PublicKey #279

ionut-arm opened this issue Oct 15, 2021 · 6 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@ionut-arm
Copy link
Member

The PublicKey type (used in TransientKeyContext) isn't documented as to what the format of the data in each variant is. This must be rectified.

@ionut-arm ionut-arm added the documentation Improvements or additions to documentation label Oct 15, 2021
@ionut-arm ionut-arm self-assigned this Oct 15, 2021
@ionut-arm
Copy link
Member Author

ionut-arm commented Nov 17, 2021

More documentation (more specifically code examples for how to actually use the TransientKeyContext) should be added, to make the context more user-friendly.

See this comment

@bootstrap-prime
Copy link

I'm attempting to build an ssh-agent on top of this library and the lack of documentation is confusing. Judging from parsec, is it just the raw components? Even if you don't document them, could you describe them? Same for signature. also judging from parsec, I think they're also raw?

@ionut-arm
Copy link
Member Author

Hey! Thanks for the feedback, I'll try to add some documentation today, though it will focus on TransientKeyContext - for the lower level stuff (around Context) it's better to just use the spec as the documentation, and we can help with navigating that as well. I'll also summarise it in a comment here, since I'm not sure when we'll be pushing out the next release.

@ionut-arm
Copy link
Member Author

I've opened #347 - let me know if you'd also like a summary here as well, or if the PR is enough to get you going :)

@bootstrap-prime
Copy link

That helps, thank you very much! I might have more questions in the future but this is probably enough to get me going.

@ionut-arm
Copy link
Member Author

Done in #347

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants