Merge pull request #377 from libp2p/add-b2b-guide

WebRTC connectivity guide
libp2p · Jun 12, 2024 · 5886d88 · 5886d88
2 parents f078847 + d1b9fe0
commit 5886d88
Show file tree

Hide file tree

Showing 16 changed files with 568 additions and 2 deletions.
diff --git a/assets/js/highlight.js b/assets/js/highlight.js
@@ -10,6 +10,7 @@ import markdown from 'highlight.js/lib/languages/markdown';
 import python from 'highlight.js/lib/languages/python';
 import go from 'highlight.js/lib/languages/go';
 import rust from 'highlight.js/lib/languages/rust';
+import diff from 'highlight.js/lib/languages/diff';
 
 hljs.registerLanguage('javascript', javascript);
 hljs.registerLanguage('json', json);
@@ -22,6 +23,7 @@ hljs.registerLanguage('md', markdown);
 hljs.registerLanguage('python', python);
 hljs.registerLanguage('go', go);
 hljs.registerLanguage('rust', rust);
+hljs.registerLanguage('diff', diff);
 
 document.addEventListener('DOMContentLoaded', () => {
   document.querySelectorAll('pre code:not(.language-mermaid)').forEach((block) => {

diff --git a/assets/scss/app.scss b/assets/scss/app.scss
@@ -8,7 +8,7 @@
 @import "bootstrap/scss/bootstrap";
 
 /** Import highlight.js */
-// @import "highlight.js/scss/github-dark-dimmed";
+@import "highlight.js/scss/monokai";
 
 /** Import KaTeX */
 @import "katex/dist/katex";

diff --git a/content/concepts/nat/circuit-relay.md b/content/concepts/nat/circuit-relay.md
@@ -21,7 +21,7 @@ The circuit relay protocol is inspired by [TURN](https://tools.ietf.org/html/rfc
 Relay connections are end-to-end encrypted, which means that the peer acting as the relay is unable to read or tamper with any traffic that flows through the connection.
 {{< /alert >}}
 
-An important aspect of the relay protocol is that it is not "transparent". In other words, both the source and destination are aware that traffic is being relayed. This is useful, since the destination can see the relay address used to open the connection and can potentially use it to construct a path back to the source. It is also not anonymous - all participants
+An important aspect of the relay protocol is that it is not "transparent". In other words, both the source and destination are aware that traffic is being relayed. This is useful since the destination can see the relay address used to open the connection and can potentially use it to construct a path back to the source. It is also not anonymous - all participants
 are identified using their Peer ID, including the relay node.
 
 ## Protocol Versions

diff --git a/content/guides/getting-started/webrtc.md b/content/guides/getting-started/webrtc.md
diff --git a/static/webrtc-guide/browser-relay-multiaddr.png b/static/webrtc-guide/browser-relay-multiaddr.png
diff --git a/static/webrtc-guide/browsers-connected.png b/static/webrtc-guide/browsers-connected.png
diff --git a/static/webrtc-guide/circuit-relay-diagram.png b/static/webrtc-guide/circuit-relay-diagram.png
diff --git a/static/webrtc-guide/connect-to-bootstrapper.png b/static/webrtc-guide/connect-to-bootstrapper.png
diff --git a/static/webrtc-guide/connect-to-relay.png b/static/webrtc-guide/connect-to-relay.png
diff --git a/static/webrtc-guide/connected-to-bootstrapper.png b/static/webrtc-guide/connected-to-bootstrapper.png
diff --git a/static/webrtc-guide/connected-to-relay.png b/static/webrtc-guide/connected-to-relay.png
diff --git a/static/webrtc-guide/mesh.png b/static/webrtc-guide/mesh.png
diff --git a/static/webrtc-guide/pubsub-discovery.png b/static/webrtc-guide/pubsub-discovery.png
diff --git a/static/webrtc-guide/sequence-part-1.png b/static/webrtc-guide/sequence-part-1.png
diff --git a/static/webrtc-guide/sequence-part-1.svg b/static/webrtc-guide/sequence-part-1.svg
diff --git a/static/webrtc-guide/sequence-part-2.png b/static/webrtc-guide/sequence-part-2.png