You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.)
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.
The text was updated successfully, but these errors were encountered:
As the libp2p documentation gets updated, we also need to update graphics and diagrams. These consist of (but are not limited to)
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.
The text was updated successfully, but these errors were encountered: