adds hathifiles documentation too

mlibrary · Jan 28, 2025 · cec8dba · cec8dba
1 parent 58f7361
commit cec8dba
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 0 deletions.
diff --git a/docs/hathifiles/diagrams.md b/docs/hathifiles/diagrams.md
@@ -0,0 +1,19 @@
+# Hathifiles Diagrams
+
+```mermaid
+flowchart TD
+
+p[Poll]
+ht["HathiTrust"]
+w["Webhook"]
+bus["Event bus"]
+u["Update workflow"]
+db["Hathifiles Mysql DB"]
+
+p--"Is there a new update file?"-->ht
+p--"These are the new files"-->w
+w--"Here are the new update files"-->bus
+bus--"You need to process these files"-->u
+u--"pulls files"-->ht
+u--"update with this data"-->db
+```
diff --git a/docs/hathifiles/index.rst b/docs/hathifiles/index.rst
@@ -0,0 +1,4 @@
+Hathifiles
+=================
+.. toctree::
+    diagrams
diff --git a/docs/index.rst b/docs/index.rst
@@ -16,5 +16,6 @@ documentation for details.
    :caption: Contents:
 
    api/aim
+   hathifiles/index
    digifeeds/index
    future_projects/index