fix(wire): correct rzCOBS upstream framing claim in crate-level doc#8
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR corrects the telepath-wire crate-level protocol documentation to match the actual current framing used by the MVP (COBS in both directions), while noting the planned future switch to rzCOBS upstream.
Changes:
- Update
telepath-wirecrate docs to state COBS is used both directions in the current MVP - Clarify rzCOBS upstream is planned for a future roadmap stage (C2)
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| //! # Protocol overview | ||
| //! | ||
| //! - Framing: COBS downstream (Host→Target), rzCOBS upstream (Target→Host) | ||
| //! - Framing: COBS both directions in current MVP; rzCOBS upstream planned for Stage C2 |
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
crates/telepath-wire/src/lib.rs:9claimed rzCOBS as the current upstream framing. Current MVP uses COBS both directions; rzCOBS is planned for Stage C2.README.md,AGENTS.md, and all per-crate READMEs (already corrected in PR feat(emulator): add in-process host+firmware loopback example #4 / commit 39ab674).Test plan
cargo fmt --all -- --check— cleancargo clippy --workspace -- -D warnings— cleancargo test --workspace— all passCloses #7
References Stage C (C2) in #3
🤖 Generated with Claude Code