Merge pull request #18 from KyleMcMaster/feat/mermaid-docs

docs/ARCHITECTURE.md

@@ -0,0 +1,44 @@
+# Architecture
+
+## Diagrams
+
+Get all employees
+
+```mermaid
+sequenceDiagram
+    autonumber
+    Client->>Employees_Get: XHR Request
+    Employees_Get->>employees Table: query
+    employees Table-->>Employees_Get: entities
+    Employees_Get-->>Client: XHR Response (employees)
+```
+
+Create employee
+
+```mermaid
+sequenceDiagram
+    autonumber
+    Client->>Employees_Create: XHR Request (employee)
+    Employees_Create-->>employees Table: Function output (entity)
+    Employees_Create-->>Client: XHR Response (200)
+```
+
+Create payroll
+
+```mermaid
+sequenceDiagram
+    autonumber
+    Client->>Payroll_Create: XHR Request (payroll)
+    Payroll_Create->>payrolls Table: query (entity)
+    payrolls Table-->>Payroll_Create: entity
+    Payroll_Create->>payroll updates Queue: message (entity)
+    par
+      payroll updates Queue->>PayrollQueue_Update: message (entity)
+      PayrollQueue_Update->>employees Table: query (entity)
+      employees Table-->>PayrollQueue_Update: entity
+      PayrollQueue_Update->>employees Table: update (entity)
+      PayrollQueue_Update->>employeePayrolls Table: update (entity)
+    and
+      Payroll_Create-->>Client: XHR Response (payroll)
+    end
+```

payroll-processor.code-workspace

@@ -1,5 +1,9 @@
 {
   "folders": [
+    {
+      "path": "docs",
+      "name": "docs"
+    },
     {
       "path": "payroll-processor-api",
       "name": "api"
@@ -28,6 +32,7 @@
       "payroll-processor-api": true,
       "payroll-processor-client": true,
       "payroll-processor-functions": true,
+      "docs": true,
       "**/bin": true,
       "**/obj": true,
       "**/dist": true
@@ -60,7 +65,8 @@
       "dozerg.tsimportsorter",
       "stylelint.vscode-stylelint",
       "k--kato.docomment",
-      "jchannon.csharpextensions"
+      "jchannon.csharpextensions",
+      "vstirbu.vscode-mermaid-preview"
     ]
   }
 }