Open gavin-norman-sociomantic opened 6 years ago
An overview of the behaviour of connections / requests / ROCs in different circumstances (e.g. https://github.com/sociomantic-tsunami/swarm/pull/310) would also be useful.
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).
Updated the connection doc. https://github.com/sociomantic-tsunami/swarm/pull/389
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: