Improve Protocol Documentation.
@salmad3 已经在做这个了。
开始于 2022年8月29日。
评估
这个 Issue 还没有评估数据。
描述
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.
- 主要语言
- HTML
- 星标
- 72
- 派生
- 96
- PR 合并指标
- 30 天内没有已合并 PR
环境准备
这个项目没有提供开发容器、Dockerfile 或贡献指南，环境需要你自己搭建：先看它的 README，通用步骤见我们的新手贡献指南。
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
libp2p/docs 的其他 Issue
-
Broken Link未关闭
难度 1/5 1 小时以内 新手友好度 68/100
-
难度 1/5 1 小时以内 新手友好度 65/100
-
难度 2/5 1-3 小时 新手友好度 55/100
-
难度 5/5 一周以上 新手友好度 25/100
-
难度 3/5 1-2 天 新手友好度 45/100