There is a lack of feature of documentation in go-libp2p-kad-dht, which make it hard to keep the IPFS DHT spec up-to-date, and generally hard to understand what happens in the DHT implementation. We should document all features we are implementing from the start. The feature documentation should ideally live in the same repository, or alternatively on a spec/doc repository that must be kept up-to-date (e.g documentation should be added BEFORE merging the PR).
We should document the design of this implementation thoroughly.
In addition, as the Kademlia paper doesn't go much into the implementation details, we need to document them:
There is a lack of feature of documentation in go-libp2p-kad-dht, which make it hard to keep the IPFS DHT spec up-to-date, and generally hard to understand what happens in the DHT implementation. We should document all features we are implementing from the start. The feature documentation should ideally live in the same repository, or alternatively on a spec/doc repository that must be kept up-to-date (e.g documentation should be added BEFORE merging the PR).
We should document the design of this implementation thoroughly.
In addition, as the Kademlia paper doesn't go much into the implementation details, we need to document them:
We should also document all non-standard Kademlia items that we add to the libp2p/IPFS implementation, for examples: