Improve the glossary
@ElPaisano ci sta già lavorando.
Dal 25/1/2023.
Valutazione
Questa issue non è ancora stata valutata.
Descrizione
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.
- 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