mesh diagrams linked. (#66)

RossBugginsNHS · web-flow · commit 941f81517dd3 · 2025-10-16T10:46:38.000+01:00
* mesh diagrams linked.

* Update c4 context.
diff --git a/docs/_config.yml b/docs/_config.yml
@@ -60,7 +60,7 @@ gh_edit_link: true # show or hide edit this page link
 gh_edit_link_text: "Edit this page on GitHub."
 gh_edit_repository: "https://github.com/NHSDigital/nhs-notify-digital-letters" # the github URL for your repo
 gh_edit_branch: "main" # the branch that your docs is served from
-# gh_edit_source: docs # the source that your files originate from
+gh_edit_source: docs # the source that your files originate from
 gh_edit_view_mode: "tree" # "tree" or "edit" if you want the user to jump into the editor immediately
 
 nav_external_links:
diff --git a/docs/_includes/diagram.html b/docs/_includes/diagram.html
@@ -2,5 +2,5 @@
     | where_exp:"diagram", "diagram.title == include.title"
     | first %}
 
-[{{ diagram.url |relative_url }}]({{ diagram.url |relative_url }})
+[Link to this diagram directly: {{ diagram.url |relative_url }}]({{ diagram.url |relative_url }})
 {{ diagram.content | markdownify }}
diff --git a/docs/_layouts/diagram.html b/docs/_layouts/diagram.html
@@ -9,6 +9,19 @@
 {% include nhs-notify-head.html %}
 
 <body>
+
+
+<h1>{{ page.title }}</h1>
+      <div>
+{{ page.description }}
+</div>
+  <div>  <a
+        href="{{ site.gh_edit_repository }}/{{site.gh_edit_view_mode}}/{{ site.gh_edit_branch }}{% if site.gh_edit_source %}/{{ site.gh_edit_source }}{% endif %}/collections/{{ page.path }}"
+        id="edit-this-page"
+        >🧾 Edit this on GitHub</a
+      >
+      </div>
+
   {{ content }}
 </body>
 
diff --git a/docs/architecture/c4/notifhir/mesh/index.md b/docs/architecture/c4/notifhir/mesh/index.md
@@ -12,7 +12,3 @@ author: Tom D'Roza
 
 
 {% include diagram.html title="c4Component-notifhir-1" %}
-
-{% include diagram.html title="c4Component-notifhir-2" %}
-
-{% include diagram.html title="c4Component-notifhir-3" %}
diff --git a/docs/architecture/c4/notifhir/mesh/poller/index.md b/docs/architecture/c4/notifhir/mesh/poller/index.md
@@ -9,3 +9,5 @@ last_modified_date: 2024-10-13
 owner: Tom D'Roza
 author: Tom D'Roza
 ---
+
+{% include diagram.html title="c4Component-notifhir-2" %}
diff --git a/docs/architecture/c4/notifhir/mesh/retriever/index.md b/docs/architecture/c4/notifhir/mesh/retriever/index.md
@@ -9,3 +9,5 @@ last_modified_date: 2024-05-28
 owner: Ross Buggins
 author: Ross Buggins
 ---
+
+{% include diagram.html title="c4Component-notifhir-3" %}
diff --git a/docs/architecture/c4/notifhir/pdm/index.md b/docs/architecture/c4/notifhir/pdm/index.md
@@ -9,46 +9,3 @@ last_modified_date: 2025-10-13
 owner: Tom D'Roza
 author: Tom D'Roza
 ---
-
-## PDM Upload
-
-```mermaid
-architecture-beta
-    service meshDownloaded(aws:res-amazon-eventbridge-event)[MESHFileDownloaded Event]
-    service pdmSaved(aws:res-amazon-eventbridge-event)[SavedToPDM Event]
-    group uploadToPdm(cloud)[UploadToPDM]
-    service uploadQueue(logos:aws-sqs)[UploadToPDM Queue] in uploadToPdm
-    service uploadLambda(logos:aws-lambda)[UploadToPDM] in uploadToPdm
-    service s3(logos:aws-s3)[S3 Bucket] in uploadToPdm
-    service pdm(server)[PDM]
-
-
-    meshDownloaded:R -- L:uploadQueue
-    uploadQueue:R --> L:uploadLambda
-    uploadLambda:B <-- T:s3
-    uploadLambda:T --> L:pdmSaved
-    uploadLambda:R --> L:pdm
-
-```
-
-## PDM Poller
-
-### Questions
-
-1. What poll interval and duration is needed for the PDM Poller?
-2. Can the polling be managed within the lambda?
-
-```mermaid
-architecture-beta
-    service eventBus(aws:res-amazon-eventbridge-event)[SavedToPDM Event]
-    service pdmReady(aws:res-amazon-eventbridge-event)[PDMDocumentReadyEvent]
-    group checkPdm(cloud)[PDMPoller]
-    service pollPdmQueue(logos:aws-sqs)[PollPDM Queue] in checkPdm
-    service pollPdmLambda(logos:aws-lambda)[PollPDM] in checkPdm
-    service pdm(server)[PDM]
-
-    eventBus:R -- L:pollPdmQueue
-    pollPdmQueue:R --> L:pollPdmLambda
-    pollPdmLambda:B --> L:pdmReady
-    pollPdmLambda:R <--> L:pdm
-```
diff --git a/docs/architecture/c4/notifhir/pdm/poller/index.md b/docs/architecture/c4/notifhir/pdm/poller/index.md
@@ -9,3 +9,5 @@ last_modified_date: 2024-05-28
 owner: Ross Buggins
 author: Ross Buggins
 ---
+
+{% include diagram.html title="c4code-pdm-poller" %}
diff --git a/docs/architecture/c4/notifhir/pdm/saver/index.md b/docs/architecture/c4/notifhir/pdm/saver/index.md
@@ -9,3 +9,5 @@ last_modified_date: 2024-05-28
 owner: Ross Buggins
 author: Ross Buggins
 ---
+
+{% include diagram.html title="c4code-pdm-upload" %}
diff --git a/docs/architecture/c4/notifhir/printer/removefromqueue/index.md b/docs/architecture/c4/notifhir/printer/removefromqueue/index.md
@@ -9,3 +9,5 @@ last_modified_date: 2024-05-28
 owner: Ross Buggins
 author: Ross Buggins
 ---
+
+{% include diagram.html title="c4code-printer-removefromqueue" %}
diff --git a/docs/architecture/c4/notifhir/printer/sendtoqueue/index.md b/docs/architecture/c4/notifhir/printer/sendtoqueue/index.md
@@ -9,3 +9,5 @@ last_modified_date: 2024-05-28
 owner: Ross Buggins
 author: Ross Buggins
 ---
+
+{% include diagram.html title="c4code-printer-sendtoqueue" %}
diff --git a/docs/collections/_diagrams/c4Context.md b/docs/collections/_diagrams/c4Context.md
@@ -5,74 +5,77 @@ title: c4context
 ```mermaid
     C4Context
       title System Context diagram for NHS Notify Digital Letters
-      System_Ext(tie01, "Trust TIE")
-      System_Ext(print01, "Print Suplier")
-      System_Ext(sms01, "SMS Supplier")
-      Person(citizen01, "Citizen")
 
-
-
-
-
-         System_Boundary(nhse03, "Spine Services"){
-           System_Ext(pds01, "PDS")
-           System_Ext(mesh01, "Mesh")
+      System_Boundary(trusts, "NHS Trusts"){
+         System_Ext(tie01, "Trust TIE", "Stuff for description")
+      }
+
+      System_Boundary(nhse03, "MESH "){
+         System_Ext(mesh01, "Mesh", "Stuff for description")
+      }
+
+      System_Boundary(notify01, "NHS Notify") {
+         System(notify02, "NotiFHIR")
+         System_Ext(notify04, "Event Bus")
+         System_Boundary(notify01asd, "Event Consumers") {
+            System_Ext(notify03, "Core", "Description")
+            System_Ext(notify05, "Reporting", "Description")
+            System_Ext(notify06, "Suppliers API", "Description")
          }
+      }
 
-       System_Boundary(notify01, "NHS Notify") {
-          System(notify02, "NotiFHIR")
-          System_Ext(notify04, "Event Bus")
-          System_Boundary(notify01asd, "Event Consumers") {
-          System_Ext(notify03, "Core")
-          System_Ext(notify05, "Reporting")
-          System_Ext(notify06, "Suppliers API")
-          }
-        }
-
-
-        System_Boundary(nhse01, "Core Services"){
-           System_Ext(pdm01, "PDM", "PDM - NHS Health Lake")
-           SystemDb_Ext(ndr01, "NDR", "NDR - NHS Document Store")
-        }
-
-        System_Boundary(nhse04, "NHS Login"){
-           System_Ext(login01, "NHS Login")
-        }
+      System_Boundary(pdssystem, "PDS"){
+         System_Ext(pds01, "PDS", "Stuff for description")
+      }
 
-        System_Boundary(nhse02, "NHS App"){
-           System_Ext(nhsapp03, "NHS App", "Full App")
-           System_Ext(nhsapp01, "NHS App Messaging", "Inbox")
-           System_Ext(nhsapp02, "Digital Post Viewer", "Digital Viewing PDF")
-        }
+      System_Boundary(nhse01, "Core Services"){
+         System_Ext(pdm01, "PDM", "PDM - NHS Health Lake", "Description")
+         System_Ext(ndr01, "NDR", "NDR - NHS Document Store", "Description")
+      }
 
+      System_Boundary(suppliers, "Suppliers", "Description"){
+         System_Ext(print01, "Print Suplier", "Description")
+         System_Ext(sms01, "SMS Supplier", "Description")
+      }
 
+      System_Boundary(nhse02, "NHS App", "Description"){
+         System_Ext(nhsapp03, "NHS App", "Full App")
+         System_Ext(nhsapp01, "NHS App Messaging", "Inbox")
+         System_Ext(nhsapp02, "Digital Post Viewer", "Digital Viewing PDF")
+      }
 
 
+      System_Boundary(nhse04, "NHS Login"){
+         System_Ext(login01, "NHS Login")
+      }
 
+    Boundary(people, "Citizens"){
+         Person(citizen01, "Citizen")
+      }
 
 
-      Rel(tie01, mesh01, "Submits File", "MESH")
+      Rel(citizen01, login01, "Logs in", "auth")
+      Rel(citizen01, nhsapp02, "Reads digital post", "pdf")
+      Rel(citizen01, nhsapp03, "Reads message", "app messsage")
       Rel(mesh01, notify02, "Retrieve File", "MESH")
-
-      Rel(print01, citizen01, "Send Letter", "Snail Mail")
       Rel(nhsapp01, citizen01, "Send App Message", "NHSApp Message")
-      Rel(sms01, citizen01, "Send SMS", "SMS")
-
       Rel(nhsapp03, login01, "Login", "auth")
-
-      Rel(notify02, pdm01, "Save File", "HTTP POST")
+      Rel(notify02, notify04, "Produces Event", "Event")
       Rel(notify02, pdm01, "Get File", "HTTP GET")
-
-      Rel(pdm01, ndr01, "Submits File", "API")
+      Rel(notify02, pdm01, "Save File", "HTTP POST")
+      Rel(notify03, nhsapp01, "Send App Message", "NHSApp Message")
       Rel(notify03, pds01, "Submits File", "API")
-      Rel(notify02, notify04, "Produces Event", "Event")
+      Rel(notify03, sms01, "Sends Message", "API")
       Rel(notify04, notify03, "Produces Event", "Event")
       Rel(notify04, notify05, "Produces Event", "Event")
       Rel(notify04, notify06, "Produces Event", "Event")
-
       Rel(notify06, print01, "Sends File", "API")
-      Rel(notify03, sms01, "Sends Message", "API")
-      UpdateLayoutConfig($c4ShapeInRow="8", $c4BoundaryInRow="1")
+      Rel(pdm01, ndr01, "Submits File", "API")
+      Rel(print01, citizen01, "Send Letter", "Snail Mail")
+      Rel(sms01, citizen01, "Send SMS", "SMS")
+      Rel(tie01, mesh01, "Submits File", "MESH")
+
+      UpdateLayoutConfig($c4ShapeInRow="4", $c4BoundaryInRow="2")
 
 
 
diff --git a/docs/collections/_diagrams/c4code-pdm-poller.md b/docs/collections/_diagrams/c4code-pdm-poller.md
@@ -0,0 +1,25 @@
+---
+
+title: c4code-pdm-poller
+description: PDM Poller
+---
+
+### Questions
+
+1. What poll interval and duration is needed for the PDM Poller?
+2. Can the polling be managed within the lambda?
+
+```mermaid
+architecture-beta
+    service eventBus(aws:res-amazon-eventbridge-event)[SavedToPDM Event]
+    service pdmReady(aws:res-amazon-eventbridge-event)[PDMDocumentReadyEvent]
+    group checkPdm(cloud)[PDMPoller]
+    service pollPdmQueue(logos:aws-sqs)[PollPDM Queue] in checkPdm
+    service pollPdmLambda(logos:aws-lambda)[PollPDM] in checkPdm
+    service pdm(server)[PDM]
+
+    eventBus:R -- L:pollPdmQueue
+    pollPdmQueue:R --> L:pollPdmLambda
+    pollPdmLambda:B --> L:pdmReady
+    pollPdmLambda:R <--> L:pdm
+```
diff --git a/docs/collections/_diagrams/c4code-pdm-upload.md b/docs/collections/_diagrams/c4code-pdm-upload.md
@@ -0,0 +1,25 @@
+---
+
+title: c4code-pdm-upload
+description: PDM Upload
+---
+
+
+```mermaid
+architecture-beta
+    service meshDownloaded(aws:res-amazon-eventbridge-event)[MESHFileDownloaded Event]
+    service pdmSaved(aws:res-amazon-eventbridge-event)[SavedToPDM Event]
+    group uploadToPdm(cloud)[UploadToPDM]
+    service uploadQueue(logos:aws-sqs)[UploadToPDM Queue] in uploadToPdm
+    service uploadLambda(logos:aws-lambda)[UploadToPDM] in uploadToPdm
+    service s3(logos:aws-s3)[S3 Bucket] in uploadToPdm
+    service pdm(server)[PDM]
+
+
+    meshDownloaded:R -- L:uploadQueue
+    uploadQueue:R --> L:uploadLambda
+    uploadLambda:B <-- T:s3
+    uploadLambda:T --> L:pdmSaved
+    uploadLambda:R --> L:pdm
+
+```
diff --git a/docs/collections/_diagrams/c4code-printer-removefromqueue.md b/docs/collections/_diagrams/c4code-printer-removefromqueue.md
@@ -1,15 +1,10 @@
 ---
-layout: page
-title: Digital Letters - Printed Letter TTL Management
-parent: Architecture
-nav_order: 2
-has_children: false
-is_not_draft: false
-last_modified_date: 2025-10-09
-owner: Tom D'Roza
-author: Tom D'Roza
+
+title: c4code-printer-removefromqueue
+description: PDM Upload
 ---
 
+
 ```mermaid
 architecture-beta
    group manageTTL(cloud)[ManageTTL]
diff --git a/docs/collections/_diagrams/c4code-printer-sendtoqueue.md b/docs/collections/_diagrams/c4code-printer-sendtoqueue.md
@@ -1,15 +1,10 @@
 ---
-layout: page
-title: Digital Letters - Printed Letter TTL Creation
-parent: Architecture
-nav_order: 1
-has_children: false
-is_not_draft: false
-last_modified_date: 2025-10-09
-owner: Tom D'Roza
-author: Tom D'Roza
+
+title: c4code-printer-sendtoqueue
+description: PDM Upload
 ---
 
+
 ```mermaid
    architecture-beta
     group createTtl(cloud)[Time_To_Live]
