Improve Protocol Documentation.
@salmad3 ci sta già lavorando.
Dal 29/8/2022.
Valutazione
Questa issue non è ancora stata valutata.
Descrizione
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.
- Lingua principale
- HTML
- Stelle
- 72
- Fork
- 97
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Preparare l'ambiente
Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di libp2p/docs
-
Broken LinkAperta
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 68/100
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 65/100
-
Broken navigation buttonsAperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 55/100
-
No docs for cpp-libp2pAperta
Difficoltà 5/5 Più di una settimana Idoneità per principianti 25/100
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 45/100