docs
docs copied to clipboard
Complete all concept docs
This is a meta issue to keep track of the completion of our concept articles.
Write & publish:
- [X] Transport
- [X] #14 NAT traversal
- [x] #11 Addressing / multiaddr
- [x] #12 Peer Ids
- [x] #13 Peer Routing
- [x] #39 Stream Multiplexing
- [x] #18 Protocol negotiation (multistream)
- [x] #19 Encrypted comms / secio
- [x] #23 Content Routing / DHT / record store
- [x] #32 Connections & connection upgrading
- [x] #33 Switch / Swarm
- [x] #34 Pubsub
Improve:
- [x] #17 improve Transport doc
I am interested in helping to write/contribute to some of these docs. Looking at #23, #13, and #17. How would I go about it to help you out?
Any suggested resources that you would like to recommend? Thanks in advance.
Hey @tesla809, thanks! I'm sorry I took so long to get back to you; last week I moved a few hundred miles away to an awesome new home, so I was pretty distracted :)
I think any of the issues you mentioned would be great to take on. For #17, probably the simplest piece would be to get some examples of different multiaddrs for various transports, for example, /ip4/1.2.3.4/tcp/5000/ws for websockets over TCP/IP, and that sort of thing.
For the routing articles, I've been thinking about how to structure it so that there's not a ton of duplication between peer routing and content routing. They're pretty similar, and in practice both are usually provided by the kad DHT. Maybe it makes sense to have an article just about the DHT, with articles for peer routing and content routing that refer to the DHT article. What do you think?
This js peer & content routing example might be helpful.
Also, there are repos for the peer routing interface and content routing interface that define the basic operations.
Please hit me up with questions, and thanks again for wanting to help 💯
@marten-seemann @DannyS03 and I reviewed the open items under this ticket and have assigned priorities. Will address soon.