Skip to content

Commit 02199c7

Browse files
docs: Included mermaid diagram for readme.md (#60)
Signed-off-by: Torfinn Olsen <torfinn@hashgraph.com> Signed-off-by: olsentorfinn <166747899+olsentorfinn@users.noreply.github.com> Signed-off-by: Roger Barker <roger.barker@swirldslabs.com> Co-authored-by: Roger Barker <roger.barker@swirldslabs.com>
1 parent f22c99b commit 02199c7

1 file changed

Lines changed: 18 additions & 0 deletions

File tree

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,24 @@ Project board, which captures the issues in swim lanes. The Project board can on
3434
meaning users who work in more than one org do not have a single location to view all issues. This leads to fragmented
3535
planning and execution.
3636

37+
# How does it work?
38+
39+
```mermaid
40+
%% A · System-Architecture Diagram (≤25 nodes)
41+
flowchart TD
42+
A[CLI Invocation] --> B{version2config.py<br/>Parse flags & env}
43+
B --> C[Validated Config]
44+
C --> D{version2query.py<br/>Token check}
45+
D --> E[GraphQL call projectsV2]:::api
46+
E --> F[gh project item-list]:::cli
47+
F --> G[items *.json]
48+
G --> H[Consolidate to output.items.json]
49+
H --> I{static_site_generator.py<br/>Jinja2 render}
50+
I --> J[_site/index.html]
51+
classDef api fill:#e3f2fd,stroke:#2196f3;
52+
classDef cli fill:#f1f8e9,stroke:#7cb342;
53+
```
54+
3755
# Our Solution
3856
Our python script will query the GitHub API for all issues associated with the appropriate filters provided to the CLI
3957
tool. The output will be a static HTML page showing all issues in swim lanes. This provides a comprehensive overview

0 commit comments

Comments
 (0)