Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Modularize and enhance Publish/Subscribe content

Aperta
#236 0 commenti 1 reazione 1 assegnatario Vedi su GitHub

@salmad3 ci sta già lavorando.

Dal 23/11/2022.

Valutazione

Questa issue non è ancora stata valutata.

Descrizione

area:messaging Epic type:enhancement type:new page type:refactor

Done Criteria

  • Create an introductory doc for publish/subscribe, similar to the other core component sections (e.g. Transports, Steam Multiplexing). The title can be "What is Publish/Subscribe"
  • Create a gossipsub doc. Content updates are captured in https://github.com/libp2p/docs/issues/169.
  • Add more examples as part of "example uses of pub/sub:"
  • General writing style updates.
    • Gramatical.
    • There are descriptions that are currently commented out that were used as the image descriptors - these are useful descriptions that should be incorporated into the actual text on the page.

Why Important

While a solid explainer, there is opportunity to improve the current material and modularize the doc itself.

Notes

  • The section would resemble the following structure:
    • What is Publish/Subscribe
    • GossipSub
  • For now, we can update the images to have a transparent background so they fill the pages better (i.e. when in dark mode). However, we should eventually update all the pub/sub diagrams as part of the unified libp2p diagrams.
Lingua principale
HTML
Stelle
72
Fork
97
Nessuna PR unita negli ultimi 30g

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di libp2p/docs

Tutte le issue di libp2p/docs

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.