From b99308a2bf93ea7877d01d0af76e0d16cc6c6847 Mon Sep 17 00:00:00 2001 From: Torfinn Olsen Date: Thu, 1 May 2025 09:59:35 -0700 Subject: [PATCH 1/2] Included mermaid diagram for readme.md Signed-off-by: Torfinn Olsen --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 23eeaf0..f234b2c 100644 --- a/README.md +++ b/README.md @@ -20,3 +20,17 @@ The following items are required to run the program. Run `make install` inside the repo directory to configure the appropriate versions of dependencies. +# How does it work? +%% A · System-Architecture Diagram (≤25 nodes) +flowchart TD + A[CLI Invocation] --> B{version2config.py
Parse flags & env} + B --> C[Validated Config] + C --> D{version2query.py
Token check} + D --> E[GraphQL call projectsV2]:::api + E --> F[gh project item-list]:::cli + F --> G[items *.json] + G --> H[Consolidate to output.items.json] + H --> I{static_site_generator.py
Jinja2 render} + I --> J[_site/index.html] +classDef api fill:#e3f2fd,stroke:#2196f3; +classDef cli fill:#f1f8e9,stroke:#7cb342; From 22d17ff7633455a06db2df828d30904e347b0052 Mon Sep 17 00:00:00 2001 From: olsentorfinn <166747899+olsentorfinn@users.noreply.github.com> Date: Thu, 1 May 2025 10:16:38 -0700 Subject: [PATCH 2/2] Update README.md added mermaid brackets Signed-off-by: olsentorfinn <166747899+olsentorfinn@users.noreply.github.com> Signed-off-by: Torfinn Olsen --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index f234b2c..97b0a09 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,8 @@ The following items are required to run the program. Run `make install` inside the repo directory to configure the appropriate versions of dependencies. # How does it work? + +```mermaid %% A · System-Architecture Diagram (≤25 nodes) flowchart TD A[CLI Invocation] --> B{version2config.py
Parse flags & env}