Skip to content

Fix README protocol diagram rendering#3

Merged
odeliyach merged 2 commits into
mainfrom
copilot/fix-readme-protocol-diagram
Mar 17, 2026
Merged

Fix README protocol diagram rendering#3
odeliyach merged 2 commits into
mainfrom
copilot/fix-readme-protocol-diagram

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Mar 17, 2026

The README’s protocol diagram failed to render (Mermaid parse error) when showing the client/server message flow.

  • 🛠️ Documentation: Replaced the invalid Mermaid flowchart with a valid sequence diagram that depicts length send/ack, payload transfer, counting, and printable-count response.
  • 📄 Clarity: Maintained the same protocol steps while using Mermaid syntax GitHub renders reliably.
sequenceDiagram
    participant Client
    participant Server
    Client->>Server: N (uint32, network byte order)
    Server-->>Client: Length accepted
    Client->>Server: N bytes payload
    Server->>Server: Count printable bytes
    Server-->>Client: C (uint32, network byte order)
Loading

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Co-authored-by: odeliyach <171728738+odeliyach@users.noreply.github.com>
Copilot AI changed the title [WIP] Fix parse error in README protocol diagram Fix README protocol diagram rendering Mar 17, 2026
Copilot AI requested a review from odeliyach March 17, 2026 12:22
@odeliyach odeliyach marked this pull request as ready for review March 17, 2026 12:24
@odeliyach odeliyach merged commit 684fb21 into main Mar 17, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants