Basic architecture diagram for a potential deadlink checker

1 files changed, 21 insertions, 0 deletions

diff --git a/src/deadlinks/architecture.mermaid b/src/deadlinks/architecture.mermaid
new file mode 100644
index 0000000..bacf7c0
--- /dev/null
+++ b/src/deadlinks/architecture.mermaid
@@ -0,0 +1,21 @@
+flowchart LR
+    subgraph DeadLinks
+        URLs["`[]URL{
+        - URLString
+        - LastChecked
+        - Status
+        - DestURLs
+        - Pinned
+        }`"]
+        style URLs text-align:left
+
+        Cleaner -->|"periodically delete where\nnot linked to and not pinned"| URLs
+
+        CheckerWorker -->|getNext| Queue
+        Queue -->|iterate over stale| URLs
+        CheckerWorker -->|upsert| URLs
+    end
+
+    User -->|upsert pinned| URLs
+    User -->|notify pinned| Queue
+    User -->|query by state| URLs