Add a code structure overview to the p2p README#2098
Open
oliv3rdrt wants to merge 1 commit into
Open
Conversation
The p2p README only documented the wire protocol and was marked as incomplete. Add a short section describing the crate layout and what each module is responsible for (net backend, peer_manager, sync, message, protocol, the interface and rpc modules, and the config and error modules) so a reader can orient themselves before diving into the code.
oliv3rdrt
requested review from
ImplOfAnImpl,
anyxem and
erubboli
as code owners
July 21, 2026 14:59
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
1 participant
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.
The p2p README documents the wire protocol but is marked as incomplete and does not describe how the crate itself is organised. This adds a short "Code structure" section that maps each module to its responsibility (the net backend, peer_manager, sync, message, protocol, the interface and rpc modules, and the config and error types), so a reader can get oriented before diving into the code. I also reworded the intro slightly and removed the old TODO line.
The descriptions are based on the module doc comments and the current layout of the crate. Addresses #1556.