Skip to content

Commit

Permalink
Migrate ssh diagram to mermaid.js
Browse files Browse the repository at this point in the history
This commit migrates a diagram in the ssh lib to mermaid.js, leaving the
other diagram in lib, as it cannot be ported at the moment.
  • Loading branch information
Benjamin-Philip committed May 2, 2024
1 parent 0bc713d commit 792b2cf
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 2 deletions.
Binary file removed lib/ssh/doc/assets/SSH_protocols.png
Binary file not shown.
14 changes: 13 additions & 1 deletion lib/ssh/doc/guides/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,19 @@ concepts of **OTP**, and has a basic understanding of **public keys**.

Conceptually, the SSH protocol can be partitioned into four layers:

![SSH Protocol Architecture](assets/SSH_protocols.png "SSH Protocol Architecture")
```mermaid
---
title: SSH Protocol Architecture
---
block-beta
columns 2
l1["SSH Client/Server Applications"]:2
l2a["Connection Protocol"] l2b["Authentication Protocol"]
l3["Transport Protocol"]:2
l4["TCP/IP Stack"]:2
```

### Transport Protocol

Expand Down
2 changes: 1 addition & 1 deletion make/ex_doc.exs
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@ config = [
before_closing_body_tag: fn
:html ->
"""
<script src="https://cdn.jsdelivr.net/npm/mermaid@10.2.3/dist/mermaid.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/mermaid@10.9.0/dist/mermaid.min.js"></script>
<script>
document.addEventListener("DOMContentLoaded", function () {
mermaid.initialize({
Expand Down

0 comments on commit 792b2cf

Please sign in to comment.