fix(docs): add outer frame encapsulation preamble to SPEC.md §3 (PILOT-419)#2
Merged
Merged
Conversation
…T-419) Add a preamble to §3 (Packet Format) explaining that all wire-format frames are encapsulated in a tunnel envelope identified by 4-byte magic bytes. Documents the four frame types (PILT, PILS, PILK, PILA) with their magic byte values and clarifies that §3 describes the inner header for PILT frames while §4 covers the other frame type layouts. A first-time reader encountering §3 would not know the header is tunnel-encapsulated — this preamble addresses that gap. Closes PILOT-419
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.
What
Adds a preamble to §3 (Packet Format) in SPEC.md explaining the outer frame encapsulation structure.
Why
§3 previously jumped straight into the 34-byte header layout without explaining that all wire-format frames are encapsulated in tunnel envelopes identified by 4-byte magic bytes. A first-time reader encountering §3 would not know the header is tunnel-encapsulated. The four frame types (PILT, PILS, PILK, PILA) were only documented in §4, leaving §3 as a standalone section with no context.
What changed
Verification
SPEC.md— 15 lines added, no changes to existing contentCloses PILOT-419