Skip to content

Commit 16c00a6

Browse files
committed
Included mermaid diagram for readme.md
1 parent 8d9c0ae commit 16c00a6

1 file changed

Lines changed: 14 additions & 0 deletions

File tree

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,17 @@ The following items are required to run the program.
2020

2121
Run `make install` inside the repo directory to configure the appropriate versions of dependencies.
2222

23+
# How does it work?
24+
%% A · System-Architecture Diagram (≤25 nodes)
25+
flowchart TD
26+
A[CLI Invocation] --> B{version2config.py<br/>Parse flags & env}
27+
B --> C[Validated Config]
28+
C --> D{version2query.py<br/>Token check}
29+
D --> E[GraphQL call projectsV2]:::api
30+
E --> F[gh project item-list]:::cli
31+
F --> G[items *.json]
32+
G --> H[Consolidate to output.items.json]
33+
H --> I{static_site_generator.py<br/>Jinja2 render}
34+
I --> J[_site/index.html]
35+
classDef api fill:#e3f2fd,stroke:#2196f3;
36+
classDef cli fill:#f1f8e9,stroke:#7cb342;

0 commit comments

Comments
 (0)