libp2p / libp2p/docs

Improve Protocol Documentation.

Open
#120 3 comments 0 reactions 1 assignee View on GitHub

@salmad3 is already working on this.

Since Aug 29, 2022.

area:general P2 type:enhancement
Dominant language
HTML
Stars
72
Forks
97
PR merge metrics
No merged PRs in 30d

Description

First of all, thanks for the documentation. I appreciate the effort that goes into it. Thing is, I just read the protocol section in the documentation here and I have to say it leaves me with more questions than answers.

What I got from it is basically that protocol allows nodes to communicate in a particular way. But I know that already from it being called protocol and I do not have to read the piece. The information about protocol Ids and protocol negotiation also does not provide much value.

I think what I am missing is:

  • What is a structure of a protocol in libp2p? What interface does it provide, what are the rules to follow etc
  • Do not just list examples of inbuilt protocol (Ping, Identify, secio etc) but show how to use them and relate it to the interface they provide.
  • And maybe an advance section that quickly shows how to write a custom protocol.

I think the documentation on protocol will be improved is these points are taken into consideration.

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.