feat: add some documentation

2024-05-05 13:47:08 +02:00
parent 94f39bac8e
commit f4853821d4
6 changed files with 194 additions and 6 deletions
--- a/docs/NODE_DEFINITION.md
+++ b/docs/NODE_DEFINITION.md
@@ -0,0 +1,38 @@
+# Node Definition
+
+Which arguments a node expects is defined in a single `.json` file that is embedded into our node. It consists of three main fields:
+
+## id
+
+`user-name/namespace/node-id`
+
+## outputs
+
+```json
+"outputs": [
+  "geometry"
+]
+```
+
+## inputs
+
+```json
+"inputs": {
+  "height": {
+    "type": "float",
+    "value": 2
+  },
+  "radius": {
+    "type": "float",
+    "value": 0.5
+  }
+}
+```
+
+## meta (optional)
+
+The meta object is optional and can contain two other fields:
+
+`title`
+
+`description`