docs: add protocol architecture and connection lifecycle guides#5
Open
charantejguniganti wants to merge 1 commit into
Open
docs: add protocol architecture and connection lifecycle guides#5charantejguniganti wants to merge 1 commit into
charantejguniganti wants to merge 1 commit into
Conversation
Author
|
[DMP 2026]: Gossipsub 1.4 Large Message Handling, Specification PR and Candidate Recommendation #1 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR introduces a new architecture-focused documentation section aimed at improving contributor onboarding and providing a systems-level understanding of how libp2p protocols interact together.
While the repository contains detailed protocol specifications, understanding the overall networking stack currently requires navigating across many independent documents. This PR adds centralized architectural references that connect the transport, security, multiplexing, discovery, and application layers into a cohesive learning flow.
The documentation focuses on:
Changes Included
New Documentation
Added Content
README Updates
Why This Helps
This improves:
Design Goals
The documentation intentionally focuses on:
Future Extensions
Potential follow-up additions could include:
Notes
This PR does not introduce protocol or semantic changes.
It is intended purely as an educational and onboarding-focused documentation enhancement.