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

Protocol reference documentation #10

Open
cornelius opened this issue Jan 14, 2019 · 1 comment
Open

Protocol reference documentation #10

cornelius opened this issue Jan 14, 2019 · 1 comment
Assignees
Milestone

Comments

@cornelius
Copy link
Member

We need reference documentation for the peer-to-peer protocol. This is important for people who want to understand how Unit-e works in detail as well as developers who want to work on unit-e or other software which needs to deal with the protocol.

Maybe there it would be good to generate this documentation from information maintained as part of the unit-e source code so that it's naturally maintained and kept up to date and correct.

The bitcoin.org P2P Network documentation might be helpful as a base.

We have an initial import with names adapted to Unit-e in the doc-prototype wip branch but without any further adaptions of the content.

@cornelius cornelius added this to the 0.1 milestone Jan 24, 2019
@cornelius
Copy link
Member Author

PR to add the documentation of the P2P messages: #21

@cornelius cornelius self-assigned this Mar 1, 2019
@cornelius cornelius modified the milestones: 0.1, 1.0 Apr 9, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant