You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Minimum: libp2p public docs doesn't contain any incorrect information about hole punching, circuit relay v2, NAT traversal, etc.
Better: there is a way from libp2p public docs for a motivated reader to learn about the above.
Best: a reader coming libp2p public docs gets a well organized presentation about how hole punching works in libp2p
Why Important
Hole punching is critical new functionality in libp2p. We need to help customers discover it and get roadsigns on how they can leverage it in their application.
User/Customer
Developers using libp2p in their application who would benefit from the expanded reach that hole-punching provides.
Notes
Given current resourcing, I don't expect us to get to "best". We can close without hitting it. I'd like to push for "better" because this should just mean providing links to some of the existing great documents we have about this effort.
Documentation sources that definitely should be review to at the minimum remove erroneous information are:
Even if we don't get to "best" level, we can still link to many resources that helps a motivated user learn more. This could include blog entires, public talks, spc, etc.
The text was updated successfully, but these errors were encountered:
BigLep
changed the title
Add documentation about Circuit Relay v2
Add documentation about Project Flare (hole punching, Circuit Relay v2, NAT traveral)
Mar 17, 2022
Done Criteria
Why Important
Hole punching is critical new functionality in libp2p. We need to help customers discover it and get roadsigns on how they can leverage it in their application.
User/Customer
Developers using libp2p in their application who would benefit from the expanded reach that hole-punching provides.
Notes
The text was updated successfully, but these errors were encountered: