Skip to content

Commit

Permalink
Try and document
Browse files Browse the repository at this point in the history
  • Loading branch information
sroussey committed Feb 5, 2024
1 parent 1d4a403 commit 18faf37
Showing 1 changed file with 54 additions and 0 deletions.
54 changes: 54 additions & 0 deletions DOCUMENTATION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# Documentation

```mermaid
erDiagram
NodeType ||--o{ NodeInput : has
NodeType ||--o{ NodeOutput : has
NodeType ||--o{ NodeTheme : has
NodeInput ||--|| ValueType : uses
NodeOutput ||--|| ValueType : uses
ValueType ||..|| InputType : uses
NodeInput{
string name
string id
ValueType valueType
boolean isArray
boolean isConstant
any defaultValue
string inputGroup
}
NodeOutput{
string name
string id
ValueType valueType
boolean isArray
}
NodeTheme{
string name
string color
}
NodeType{
string name
string id
string description
NodeInput[] inputs
NodeOutput[] outputs
NodeTheme theme
}
ValueType{
string name
string color
string inputType
any defaultValue
}
```

## NodeType

A node type describes a kind of node that can put in a graph. It has a name and a list of inputs and outputs that have handles to connect to other nodes via edges.

## NodeInput

A node input is a handle that can be connected to a node output via an edge.

0 comments on commit 18faf37

Please sign in to comment.