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

Add doc oriented toward protocol developers #295

Open
4 of 13 tasks
gavin-norman-sociomantic opened this issue Mar 1, 2018 · 4 comments
Open
4 of 13 tasks

Add doc oriented toward protocol developers #295

gavin-norman-sociomantic opened this issue Mar 1, 2018 · 4 comments
Assignees

Comments

@gavin-norman-sociomantic
Copy link

gavin-norman-sociomantic commented Mar 1, 2018

All existing swarm docs are aimed at users of clients based on the library.

It would also be worth having a place to store developer documentation, for example things like https://github.com/nemanja-boric-sociomantic/swarm-1/blob/68d14d48e1aa9aba92a6018778d97df955600d44/relnotes/flush.deprecated.md.

Topics to address in documentation:

  • Low level protocol: version handshake, message protocol, auth protocol.
  • Request protocol.
  • Common: connections.
  • Common: request-on-conns.
  • Client: connections, connection set.
  • Client: request versioning, request types, requests' access to connections.
  • Client: requests, request set.
  • Client: request handlers.
  • Client: user notifiers.
  • Node: connections, connection set.
  • Node: request versioning, requests' access to connections.
  • Node: requests, request set.
  • Node: request handlers.
@gavin-norman-sociomantic gavin-norman-sociomantic added this to the v4.7.0 milestone Mar 1, 2018
@gavin-norman-sociomantic
Copy link
Author

An overview of the behaviour of connections / requests / ROCs in different circumstances (e.g. #310) would also be useful.

gavin-norman-sociomantic pushed a commit to gavin-norman-sociomantic/swarm that referenced this issue May 17, 2018
@gavin-norman-sociomantic
Copy link
Author

Another important thing to note somewhere: when changing the protocol in swarm, deprecated code should only be removed when it is no longer used by any dependent repo (e.g. *protos).

gavin-norman-sociomantic pushed a commit to gavin-norman-sociomantic/swarm that referenced this issue May 30, 2018
gavin-norman-sociomantic pushed a commit to gavin-norman-sociomantic/swarm that referenced this issue May 30, 2018
gavin-norman-sociomantic pushed a commit to gavin-norman-sociomantic/swarm that referenced this issue May 30, 2018
gavin-norman-sociomantic pushed a commit to gavin-norman-sociomantic/swarm that referenced this issue May 30, 2018
gavin-norman-sociomantic pushed a commit to gavin-norman-sociomantic/swarm that referenced this issue May 30, 2018
gavin-norman-sociomantic pushed a commit to gavin-norman-sociomantic/swarm that referenced this issue Jun 12, 2018
gavin-norman-sociomantic pushed a commit to gavin-norman-sociomantic/swarm that referenced this issue Jun 27, 2018
gavin-norman-sociomantic pushed a commit to gavin-norman-sociomantic/swarm that referenced this issue Aug 24, 2018
@gavin-norman-sociomantic
Copy link
Author

gavin-norman-sociomantic commented Dec 20, 2018

#324 added some doc. We need to extend this.

@matthias-wende-sociomantic
Copy link
Contributor

Updated the connection doc. #389

@gavin-norman-sociomantic gavin-norman-sociomantic modified the milestones: v5.4.0, v5.5.0 Apr 11, 2019
@Geod24 Geod24 removed this from the v5.5.0 milestone Aug 18, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants