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

docs: add initial architecture diagrams for js-libp2p #2121

Merged
merged 1 commit into from
Oct 4, 2023

Conversation

maschad
Copy link
Member

@maschad maschad commented Oct 4, 2023

Title

docs: add initial architecture diagrams for js-libp2p

Description

These diagrams in mermaid are a result of the hard work from @achingbrain @SgtPooki @whizzzkid @wemeetagain and @polus-arcticus at the js-libp2p colo to try give consumers an understanding of our architecture.

This also removes some outdated docs.

Closes #2083

Notes & open questions

This may be a temporarily place to store the docs until #2117 is completed. This list is by no means exhaustive and more scenarios are welcome.

Change checklist

  • I have performed a self-review of my own code
  • I have made corresponding changes to the documentation if necessary (this includes comments as well)
  • I have added tests that prove my fix is effective or that my feature works

@maschad maschad requested a review from a team as a code owner October 4, 2023 03:49
@maschad maschad merged commit e8123d3 into libp2p:master Oct 4, 2023
18 checks passed
@maschad maschad deleted the docs/architecture-diagrams branch October 4, 2023 16:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

docs: architecture diagrams
2 participants