Skip to content

Commit 1c5c1a2

Browse files
docs: add wire protocol reference for non-plugin SDKs (#57)
1 parent bfd0186 commit 1c5c1a2

2 files changed

Lines changed: 401 additions & 0 deletions

File tree

docs/00-overview.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ questions come up.
2424
| 9 | [Synchronization](09-synchronization.md) | Deep dive on the match algorithm, cursors, and complexity. |
2525
| 10 | [lerobot integration](10-lerobot.md) | Optional plugins that wrap the Portal API for lerobot users. |
2626
| 11 | [Logging](11-logging.md) | `RUST_LOG`, the reference tags on every warning, and the cause and fix for each. |
27+
| 12 | [Wire protocol](12-wire-protocol.md) | Topics, attributes, RPC, and binary layouts for building a Portal peer in an SDK with no plugin. |
2728

2829
## How to navigate
2930

@@ -43,6 +44,9 @@ questions come up.
4344
API.
4445
- **Seeing warnings in the logs?** Every warning carries a reference tag.
4546
[Logging](11-logging.md) maps each tag to its cause and fix.
47+
- **Interfacing with Portal using another SDK?**
48+
[Wire protocol](12-wire-protocol.md) is the implementer-facing contract:
49+
topic names, participant attributes, RPC, and every binary layout.
4650

4751
## Conventions
4852

0 commit comments

Comments
 (0)