Skip to content

Commit 2393d04

Browse files
Merge pull request #18 from NHSDigital/rossbugginsnhs/2025-10-08/001-arch-docs
docs.
2 parents 1f30650 + 69fafe4 commit 2393d04

File tree

2 files changed

+64
-5
lines changed

2 files changed

+64
-5
lines changed

docs/_config.yml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
# You can create any custom variable you would like, and they will be accessible
1919
# in the templates via {{ site.myvariable }}.
2020

21-
title: NHS Notify Repo Template
21+
title: NHS Notify Digital Letters
2222
2323
description: >- # this means to ignore newlines until "baseurl:"
2424
Repository Template documentation for the NHS Notify Platform.
@@ -42,18 +42,18 @@ plugins:
4242
mermaid:
4343
# Version of mermaid library
4444
# Pick an available version from https://cdn.jsdelivr.net/npm/mermaid/
45-
version: "10.9.1"
45+
version: "11.12.0"
4646

4747
aux_links:
48-
"NHS Notify Repo Template on GitHub":
49-
- "//github.com/NHSDigital/nhs-notify-repository-template"
48+
"NHS Notify Digital Letters on GitHub":
49+
- "//github.com/NHSDigital/nhs-notify-digital-letters"
5050

5151
aux_links_new_tab: false
5252

5353
# Footer "Edit this page on GitHub" link text
5454
gh_edit_link: true # show or hide edit this page link
5555
gh_edit_link_text: "Edit this page on GitHub."
56-
gh_edit_repository: "https://github.com/NHSDigital/nhs-notify-repository-template" # the github URL for your repo
56+
gh_edit_repository: "https://github.com/NHSDigital/nhs-notify-digital-letters" # the github URL for your repo
5757
gh_edit_branch: "main" # the branch that your docs is served from
5858
# gh_edit_source: docs # the source that your files originate from
5959
gh_edit_view_mode: "tree" # "tree" or "edit" if you want the user to jump into the editor immediately

docs/architecture/c4/index.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
---
2+
layout: page
3+
title: C4 Context
4+
parent: Architecture
5+
nav_order: 6
6+
has_children: true
7+
is_not_draft: false
8+
last_modified_date: 2024-05-28
9+
owner: Ross Buggins
10+
author: Ross Buggins
11+
---
12+
13+
```mermaid
14+
C4Context
15+
title System Context diagram for Internet Banking System
16+
Enterprise_Boundary(b0, "BankBoundary0") {
17+
Person(customerA, "Banking Customer A", "A customer of the bank, with personal bank accounts.")
18+
Person(customerB, "Banking Customer B")
19+
Person_Ext(customerC, "Banking Customer C", "desc")
20+
21+
Person(customerD, "Banking Customer D", "A customer of the bank, <br/> with personal bank accounts.")
22+
23+
System(SystemAA, "Internet Banking System", "Allows customers to view information about their bank accounts, and make payments.")
24+
25+
Enterprise_Boundary(b1, "BankBoundary") {
26+
27+
SystemDb_Ext(SystemE, "Mainframe Banking System", "Stores all of the core banking information about customers, accounts, transactions, etc.")
28+
29+
System_Boundary(b2, "BankBoundary2") {
30+
System(SystemA, "Banking System A")
31+
System(SystemB, "Banking System B", "A system of the bank, with personal bank accounts. next line.")
32+
}
33+
34+
System_Ext(SystemC, "E-mail system", "The internal Microsoft Exchange e-mail system.")
35+
SystemDb(SystemD, "Banking System D Database", "A system of the bank, with personal bank accounts.")
36+
37+
Boundary(b3, "BankBoundary3", "boundary") {
38+
SystemQueue(SystemF, "Banking System F Queue", "A system of the bank.")
39+
SystemQueue_Ext(SystemG, "Banking System G Queue", "A system of the bank, with personal bank accounts.")
40+
}
41+
}
42+
}
43+
44+
BiRel(customerA, SystemAA, "Uses")
45+
BiRel(SystemAA, SystemE, "Uses")
46+
Rel(SystemAA, SystemC, "Sends e-mails", "SMTP")
47+
Rel(SystemC, customerA, "Sends e-mails to")
48+
49+
UpdateElementStyle(customerA, $fontColor="red", $bgColor="grey", $borderColor="red")
50+
UpdateRelStyle(customerA, SystemAA, $textColor="blue", $lineColor="blue", $offsetX="5")
51+
UpdateRelStyle(SystemAA, SystemE, $textColor="blue", $lineColor="blue", $offsetY="-10")
52+
UpdateRelStyle(SystemAA, SystemC, $textColor="blue", $lineColor="blue", $offsetY="-40", $offsetX="-50")
53+
UpdateRelStyle(SystemC, customerA, $textColor="red", $lineColor="red", $offsetX="-50", $offsetY="20")
54+
55+
UpdateLayoutConfig($c4ShapeInRow="3", $c4BoundaryInRow="1")
56+
57+
58+
59+
```

0 commit comments

Comments
 (0)