(some of these could be considered specs, others would be non-mandatory "suggested usage" guides)
[ ] a doc describing exactly how these are tied together, a spec for the ‘swarm’
[ ] document describing how dialing works.
[ ] document describing the ‘libp2p api’. Which is not language specific, but a broader description of the capabilities of each subsystem in terms of what it does.
The non-normative technical walkthrough I'm writing covers these topics. @yusefnapora is working on docs.libp2p.io. We have docs under control -- we just need to get specs aligned now.
(some preliminary brainstorming based on a discussion with @whyrusleeping, @bigs)
Goal
Revise/update/improve libp2p specs and provide clearer usage guidance
List of proposed documents
1. Base wire formats
2. libp2p book / Usage
(some of these could be considered
specs
, others would be non-mandatory "suggested usage" guides)3. Libp2p ‘builtin’ protocols
4. Other
Format notes: