feat: Port architecture section to docusaurus

buttplugio · Dec 21, 2022 · c14efc5 · c14efc5
1 parent 8834ac8
commit c14efc5
Show file tree

Hide file tree

Showing 10 changed files with 12 additions and 7 deletions.
diff --git a/...per-guide/architecture/client-in-depth.md → docs/architecture/client-in-depth.md b/...per-guide/architecture/client-in-depth.md → docs/architecture/client-in-depth.md
@@ -1,6 +1,6 @@
 # Client Architecture
 
-![Buttplug Client Architecture Diagram](./client.png)
+![Buttplug Client Architecture Diagram](/img/architecture/client.png)
 
 Applications use clients to talk to Buttplug Servers. Let's go over what each part of clients and connectors do.
 

diff --git a/developer-guide/architecture/intro.md → docs/architecture/intro.md b/developer-guide/architecture/intro.md → docs/architecture/intro.md
@@ -4,7 +4,7 @@ In this section, we'll cover Buttplug's core protocol and architectures. Getting
 
 None of this chapter is programming language specific. While how these structures are implemented across programming languages may differ, the general idea will be the same across most systems. Any stark differences should be called out in documentation for the specific language implementations.
 
-::: tip If you don't understand this section on first read, THAT'S OK!
+:::tip If you don't understand this section on first read, THAT'S OK!
 
 This guide is written in "theory then application" order. If you're more of an application than theory learner, that's fine! Just take a quick read through here, see what you pick up, then move on to the "Writing Applications" chapter and come back to this once you've gotten your hands (or other bits) dirty.
 

diff --git a/...r-guide/architecture/protocol-in-depth.md → docs/architecture/protocol-in-depth.md b/...r-guide/architecture/protocol-in-depth.md → docs/architecture/protocol-in-depth.md
@@ -2,7 +2,7 @@
 
 At the core of Buttplug is the Buttplug Protocol. This protocol is defined in the [Buttplug Spec](https://buttplug-spec.docs.buttplug.io).
 
-::: tip Why is there a protocol specification?
+:::tip Why is there a protocol specification?
 
 It may seem a little silly to go to such formal lengths for a system for controlling sex toys, and it admittedly does introduce a level of formality that isn't seen outside of larger systems like web browsers. However, this serves a couple of functions:
 
@@ -58,7 +58,7 @@ Adding new functionality to Buttplug means adding new message, so when Buttplug
 
 Message additions are a rather complicated process. Message addition procedure is outlined in the Inflating Buttplug section, but for now, just knowing these terms is enough so you can translate what project contributors are talking about when they discuss the spec and new messages.
 
-::: tip Can Clients and Servers of different spec versions talk to each other?
+:::tip Can Clients and Servers of different spec versions talk to each other?
 
 Yes, in some cases.
 

diff --git a/...per-guide/architecture/server-in-depth.md → docs/architecture/server-in-depth.md b/...per-guide/architecture/server-in-depth.md → docs/architecture/server-in-depth.md
@@ -1,6 +1,6 @@
 # Server Architecture
 
-![Buttplug Server Architecture Diagram](./server.png)
+![Buttplug Server Architecture Diagram](/img/architecture/server.png)
 
 As a developer using the Buttplug library for applications, your access to Buttplug Servers is limited to some setup methods. Otherwise, most of your interaction with a server will be via the Client API. It's still good to know a bit about what the inside of the server looks like though, if only so you can understand [what's being complained about on twitter](https://twitter.com/buttplugio).
 

diff --git a/...e/architecture/sessions-and-components.md → docs/architecture/sessions-and-components.md b/...e/architecture/sessions-and-components.md → docs/architecture/sessions-and-components.md
@@ -1,6 +1,6 @@
 # Buttplug Sessions and Components
 
-![Buttplug Architecture Diagram](./architecture.png)
+![Buttplug Architecture Diagram](/img/architecture/architecture.png)
 
 ## Buttplug Sessions
 

diff --git a/developer-guide/architecture/terms.md → docs/architecture/terms.md b/developer-guide/architecture/terms.md → docs/architecture/terms.md
@@ -1,4 +1,4 @@
-## Glossary
+# Glossary
 
 Just in case you don't want to go digging through the architecture section again, here's a quick list of common terms.
 

diff --git a/sidebars.js b/sidebars.js
@@ -22,6 +22,11 @@ const sidebars = {
       label: 'Introduction',
       items: ['intro/introduction', 'intro/how-to-read', 'intro/buttplug-ethics', 'intro/getting-help'],
     },
+    {
+      type: 'category',
+      label: 'Strategies Against Buttplug Architecture',
+      items: ['architecture/intro', 'architecture/sessions-and-components', 'architecture/protocol-in-depth', 'architecture/client-in-depth', 'architecture/server-in-depth', 'architecture/terms'],
+    },
   ],
 };
 

diff --git a/...loper-guide/architecture/architecture.png → static/img/architecture/architecture.png b/...loper-guide/architecture/architecture.png → static/img/architecture/architecture.png
diff --git a/developer-guide/architecture/client.png → static/img/architecture/client.png b/developer-guide/architecture/client.png → static/img/architecture/client.png
diff --git a/developer-guide/architecture/server.png → static/img/architecture/server.png b/developer-guide/architecture/server.png → static/img/architecture/server.png