Improve the glossary
Open
@ElPaisano is already working on this.
Since Jan 25, 2023.
area:general
P2
- Dominant language
- HTML
- Stars
- 72
- Forks
- 97
- PR merge metrics
- No merged PRs in 30d
Description
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.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.