From bc2b79067e951a2acc951831fed8cd016d4e1273 Mon Sep 17 00:00:00 2001 From: mostalive Date: Tue, 15 Sep 2026 14:29:17 +0000 Subject: [PATCH 1/4] Update README.md --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index 0159e34..9a50574 100644 --- a/README.md +++ b/README.md @@ -22,6 +22,11 @@ The `src/Before/` folder contains a small domain model (Client, Order) backed by ``` dotnet build ``` +4. On windows: npm install @mermaid-js/mermaid-cli (global install failed) +5. Verify mermaid runs + ``` + ./node-modules/.bin/mmdc + ``` ## Tasks From 6c8459f48bfb84115d4fe8b3491590cb551e259f Mon Sep 17 00:00:00 2001 From: mostalive Date: Tue, 15 Sep 2026 14:32:58 +0000 Subject: [PATCH 2/4] Add AGENTS.md --- AGENTS.md | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 AGENTS.md diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..205e77e --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,6 @@ +# Purpose +This is a C# exercise repository to explore creating class and sequence diagrams with mermaid, in order to understand an unfamiliar codebase, perform continuous architecture review, or review code generated by coding agents. + +# Generating mermaid diagrams and reviewing syntax + +On linux and mac, the `mmdc` executable is available to create svg diagrams and check syntax. On windows, use the mmdc binary in `./node_modules/bin/mmdc` . From 490053803d2537daf6f7428ddeb10c67adeea75a Mon Sep 17 00:00:00 2001 From: mostalive Date: Tue, 15 Sep 2026 14:34:05 +0000 Subject: [PATCH 3/4] ignore node_modules --- .gitignore | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.gitignore b/.gitignore index 5f0cf05..a987355 100644 --- a/.gitignore +++ b/.gitignore @@ -13,3 +13,6 @@ obj/ .dotnet/ .local/ Library/ + +## Javascript +.node_modules \ No newline at end of file From df829241c3342a6e4fbad74c0bd9d8d694369c95 Mon Sep 17 00:00:00 2001 From: mostalive Date: Tue, 15 Sep 2026 14:39:18 +0000 Subject: [PATCH 4/4] add mermaid to package.json --- package.json | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 package.json diff --git a/package.json b/package.json new file mode 100644 index 0000000..a820963 --- /dev/null +++ b/package.json @@ -0,0 +1,5 @@ +{ + "devDependencies": { + "@mermaid-js/mermaid-cli": "^11.17.0" + } +} \ No newline at end of file