Skip to content

Modularize and enhance Publish/Subscribe content #236

Open
@salmad3

Description

@salmad3

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 Update PubSub page to reflect GossipSub v1.1 changes #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.

Metadata

Metadata

Assignees

Labels

Epicarea:messagingContent on messagingtype:enhancementContent enhancement, new feature or request.type:new pageNew content pagetype:refactorContent refactoring, restructuring, and optimizations

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions