Initial documentation, partial Protocol documentation

2026-08-06 18:17:57 +01:00
parent 1cd6bb695c
commit 7fff7bf72e
4 changed files with 196 additions and 0 deletions
@@ -0,0 +1,12 @@
+# DynaLab Core Documentation
+
+This documentation is ordered in the following sections
+- API
+- Protocol
+- Internal
+
+[**API**](API.md) - Documents the user side API of the `Core` class, this goes through setting up a new core, and how to interact with it
+
+[**Protocol**](Protocol.md) - Documents the data ingress protocol, this is useful for developing connectors to pipe data into the DynaLab Core
+
+[**Internal**](Internal/README.md) - Documents the inner working of DynaLab Core including data flow, internal API's, custom file types and much more