Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve the glossary #305

Open
3 tasks
salmad3 opened this issue Jan 25, 2023 · 1 comment
Open
3 tasks

Improve the glossary #305

salmad3 opened this issue Jan 25, 2023 · 1 comment
Assignees
Labels
area:general General content and concepts P2 Medium

Comments

@salmad3
Copy link
Member

salmad3 commented Jan 25, 2023

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.

@salmad3 salmad3 added P2 Medium area:general General content and concepts labels Jan 25, 2023
@ElPaisano
Copy link
Contributor

@DannyS03 I can take this issue

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:general General content and concepts P2 Medium
Projects
None yet
Development

No branches or pull requests

2 participants