summaryrefslogtreecommitdiff
path: root/docs/src/api/architecture.md
diff options
context:
space:
mode:
authorjwijenbergh <jeroenwijenbergh@protonmail.com>2023-05-01 14:19:32 +0200
committerJeroen Wijenbergh <46386452+jwijenbergh@users.noreply.github.com>2023-09-25 09:43:37 +0200
commitd4939e8694a6762dc9de2f4027266850f49790ac (patch)
tree89545f23dbb74766ed42dd1824c59eae35f26800 /docs/src/api/architecture.md
parentc654b48763592baae78b10f6fefec10be29e979b (diff)
Docs: Update API section for V2
Diffstat (limited to 'docs/src/api/architecture.md')
-rw-r--r--docs/src/api/architecture.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/docs/src/api/architecture.md b/docs/src/api/architecture.md
new file mode 100644
index 0000000..72f63ef
--- /dev/null
+++ b/docs/src/api/architecture.md
@@ -0,0 +1,11 @@
+# Architecture
+In the previous section, we have already hinted a bit on the exact architecture. This section will expand upon it by giving a figure of the basic structure
+
+```mermaid
+graph TD;
+A[Go]-- Compiles to -->B[C shared library .so/.dll];
+C[Language wrapper]-- Loads -->B
+Client -- Uses --> C;
+```
+
+As can be seen by this architecture, there is an intermediate layer between the client and the *shared* library. This wrapper eases the way of loading this library and then defining a more language specific API for it. In the eduvpn-common repo, we currently only support a Python wrapper. Clients themselves can define their own wrapper