libp2p / libp2p/docs

Unified libp2p graphics and diagrams

Open
#206 0 comments 2 reactions 1 assignee View on GitHub

@salmad3 is already working on this.

Since Nov 17, 2022.

Epic P2 type:enhancement
Dominant language
HTML
Stars
72
Forks
97
PR merge metrics
No merged PRs in 30d

Description

As the libp2p documentation gets updated, we also need to update graphics and diagrams. These consist of (but are not limited to)

  • High-level descriptions of various protocols
  • Abstract networking diagrams
  • A mix of "product and process" visuals

and would follow a standard theme.

For upcoming docs on new libp2p optimizations and newly supported protocols, we need a way to display a high level visualization of how the protocols work.
We currently use UML diagrams but they are too low-level (usually better suited for technical specifications and design documents.)

Inspiration can be found here and here.

Going forward, we will follow the libp2p blog post approach and include new diagrams and graphics as part of the change request. However, given that the open PRs (many documenting protocols and process) have been hanging for some time, we aim to get those merged and add the diagrams shortly after to limit the friction.

In the near term where there is little to no "doc debt", it will be part of the process to request diagrams as documents are created and ship them together.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.