libp2p / libp2p/docs

Update switch stream muxer doc

Open
#33 0 comments 0 reactions 1 assignee View on GitHub

@salmad3 is already working on this.

Since Aug 29, 2022.

  • #202 by @salmad3 — closed without merging
area:multiplexing P1 type:enhancement
Dominant language
HTML
Stars
72
Forks
97
PR merge metrics
No merged PRs in 30d

Description

I mentioned the switch / swarm in the transport doc, but a more in-depth look at the public API surface and its responsibilities would help clarify things for users.

Could include:

  • discussion of peer store / peer book
  • dialing / listening API methods (examples in go, js, rust)
  • short example of dial / listen interaction flow
    • can link to related concept docs

related concept docs:

  • connection upgrade
  • protocol negotiation
  • transport
  • secure comms
  • nat traversal

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.