docs: comprehensive implementation status revamp and extensions framework guide#4
Open
shivv23 wants to merge 1 commit into
Open
Conversation
…work guide - Add py-libp2p to implementation-status.md (was completely missing) - Add v1.0, v1.1 columns to implementation-status.md for completeness - Add Test Extension and Large Message Segmentation to extensions table - Update Rust v1.2 status (verified: complete) and Go/Rust v1.3 status - Add reference links section for easy navigation - Create extensions/README.md: extensions framework documentation covering capability advertisement, field number allocation, protocol activation, extension lifecycle, and registered extension registry - Update README.md to link to implementation-status.md and add v1.3 column to inline table; correct py-libp2p v1.1/v1.2 status (verified: both ✅)
Author
|
@seetadev @johannamoran — this PR revamps the implementation status tracking and adds a comprehensive extensions framework guide. The status tables were missing py-libp2p entirely (ironic given the C4GT project focus) and had several inaccuracies I've corrected against the actual source code. The extensions README fills a documentation gap that I think becomes more important as the Large Message Segmentation and other experimental extensions mature. Would love your feedback, especially on:
|
Open
7 tasks
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.
Summary
This PR makes three improvements to the GossipSub documentation:
1. Implementation status overhaul (
implementation-status.md)The previous file was missing py-libp2p entirely (all six other implementations were listed) and lacked v1.0 / v1.1 columns, making it inconsistent with the README table.
Changes:
❔→✅) — rust-libp2p has had v1.2 for several releases2. Extensions framework guide (
extensions/README.md) — NEWA comprehensive guide to the GossipSub v1.3 Extensions Control Message framework, covering:
ControlExtensionshandshakeThis fills a gap where the extensions mechanism was documented only implicitly through the protobuf file and individual extension specs.
3. README sync
extensions/README.mdfrom the specification listlibp2p/py-libp2psource)implementation-status.mdfor the full per-extension breakdown