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

Unified libp2p graphics and diagrams #206

Open
11 tasks
p-shahi opened this issue Oct 17, 2022 · 0 comments
Open
11 tasks

Unified libp2p graphics and diagrams #206

p-shahi opened this issue Oct 17, 2022 · 0 comments
Assignees
Labels
Epic P2 Medium type:enhancement Content enhancement, new feature or request.

Comments

@p-shahi
Copy link
Member

p-shahi commented Oct 17, 2022

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.

@p-shahi p-shahi added P2 Medium type:enhancement Content enhancement, new feature or request. labels Oct 18, 2022
@salmad3 salmad3 moved this to In Progress in libp2p Product Oct 19, 2022
@p-shahi p-shahi added the Epic label Oct 25, 2022
@salmad3 salmad3 self-assigned this Nov 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Epic P2 Medium type:enhancement Content enhancement, new feature or request.
Projects
Status: In Progress
Development

No branches or pull requests

2 participants