README: Add Links to mentioned tech #6016
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Thanks for the PR @hoijui. I understand that for a user these links might be helpful, but I am a bit hesitant to link Uncyclopedia articles on mDNS, Kademlia, etc because a) it's Uncyclopedia (I'd rather link reliable sources like RFCs, papers, etc) and b) we don't always follow the "official" protocol completely, but e.g. only implement a subset of the protocol features or include some libp2p-specific changes. So if we link anything, I think it would be best to just link the libp2p specs for each protocol. Or just add a general sentence that the details of each mentioned protocol can be found in https://github.com/libp2p/specs/. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Adds links to related tech mentioned in examples/README.
This is useful to people new to the field, like me.
Notes & open questions
I am not very happy with the link for IPFS private swarm, but despite looking for 10+ min, I could not find a link that would fit better, and it is a term that laymen will unlikely understand.