docs: update to align with current implementation#1823
Open
robekl wants to merge 1 commit intomeshcore-dev:mainfrom
Open
docs: update to align with current implementation#1823robekl wants to merge 1 commit intomeshcore-dev:mainfrom
robekl wants to merge 1 commit intomeshcore-dev:mainfrom
Conversation
liamcottle
requested changes
Feb 25, 2026
Member
liamcottle
left a comment
liamcottle
left a comment
There was a problem hiding this comment.
Other than the couple of comments I added, everything else looks pretty good thanks :)
| - `path` - size provided by `path_length` - Path to use for Direct Routing | ||
| - Up to a maximum of 64 bytes, defined by `MAX_PATH_SIZE` | ||
| - v1.12.0 firmware and older drops packets with `path_length` [larger than 64](https://github.com/meshcore-dev/MeshCore/blob/e812632235274ffd2382adf5354168aec765d416/src/Dispatcher.cpp#L144) | ||
| - Current firmware drops packets with `path_length` larger than 64 |
Member
There was a problem hiding this comment.
This won't be accurate when multi-byte-paths branch is merged in, hence it was worded to say v1.12.0 firmware and older. v1.14.0+ firmware would allow packets with path_length > 64, as it uses those upper bits for new path info flags. I'd probably suggest reverting this line, and when the branch is merged we can add an extra line explaining the new functionality.
| - Generally this is the remainder of the raw packet data | ||
| - The firmware parses this data based on the provided Payload Type | ||
| - v1.12.0 firmware and older drops packets with `payload` sizes [larger than 184](https://github.com/meshcore-dev/MeshCore/blob/e812632235274ffd2382adf5354168aec765d416/src/Dispatcher.cpp#L152) | ||
| - Current firmware drops packets with `payload` sizes larger than 184 |
Member
There was a problem hiding this comment.
Same comment about multi-byte-paths above.
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
2 participants
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
Documentation-only PR to align
maindocs with currentdevbehavior and protocol details.High-Level Changes by Category
Companion Behavior & Routing
CLI Documentation
Companion Protocol
Payload & Packet Specs
FAQ Accuracy