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

Modularize and enhance Publish/Subscribe content #236

Open
6 tasks done
salmad3 opened this issue Nov 20, 2022 · 0 comments
Open
6 tasks done

Modularize and enhance Publish/Subscribe content #236

salmad3 opened this issue Nov 20, 2022 · 0 comments
Assignees
Labels
area:messaging Content on messaging Epic type:enhancement Content enhancement, new feature or request. type:new page New content page type:refactor Content refactoring, restructuring, and optimizations

Comments

@salmad3
Copy link
Member

salmad3 commented Nov 20, 2022

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.
@salmad3 salmad3 added area:messaging Content on messaging type:enhancement Content enhancement, new feature or request. type:new page New content page type:refactor Content refactoring, restructuring, and optimizations Epic labels Nov 20, 2022
@salmad3 salmad3 self-assigned this Nov 23, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:messaging Content on messaging Epic type:enhancement Content enhancement, new feature or request. type:new page New content page type:refactor Content refactoring, restructuring, and optimizations
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant