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

Document all features #54

Open
12 of 19 tasks
guillaumemichel opened this issue Jul 6, 2023 · 0 comments
Open
12 of 19 tasks

Document all features #54

guillaumemichel opened this issue Jul 6, 2023 · 0 comments
Labels
scope/nicetohave Nice to have feature going beyond go-libp2p-kad-dht

Comments

@guillaumemichel
Copy link
Contributor

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:

@guillaumemichel guillaumemichel added the scope/nicetohave Nice to have feature going beyond go-libp2p-kad-dht label Jul 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
scope/nicetohave Nice to have feature going beyond go-libp2p-kad-dht
Projects
None yet
Development

No branches or pull requests

1 participant