Modularize and enhance Publish/Subscribe content
Open
@salmad3 is already working on this.
Since Nov 23, 2022.
area:messaging
Epic
type:enhancement
type:new page
type:refactor
- Dominant language
- HTML
- Stars
- 72
- Forks
- 97
- PR merge metrics
- No merged PRs in 30d
Description
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.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.