Improve the glossary
未关闭
@ElPaisano 已经在做这个了。
开始于 2023年1月25日。
评估
这个 Issue 还没有评估数据。
描述
area:general
P2
Context
- Many terms that aren't yet in the glossary should be.
- There is an opportunity writing style edits, including condensing the long explanations for certain content.
Done Criteria
- Add the following terms:
- Routing
- Stream
- Hash
- Key
- Packet
- Frame
- DNS
- Encryption
- Authentication
- Gossip
- Latency
- Firewall
- Routing table
- TCP
- UDP
- WebSockets
- SDP
- STUN
- TURN
- Certificate Authority (CA)
- RLPx
- DTLS
- Signaling server
- Multicodecs
- (feel free to add others)
- Condense definitions for terms and phrases that are too long
- Create a hierarchical organization for related terms / phrases. For instance:
- Addresses
- IP Address
- Multiaddresses
- Hash
- Multihash
- NAT traversal
- STUN
- TURN
- Node
- Boot node
Why Important
The glossary is key tool for understanding the concepts in the libp2p documentation, and serves as a general reference point for fundamental terms and phrases, which should exhaustive and up-to-date.
- 主要语言
- 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