Skip to content

docs: Included mermaid diagram for readme.md #60

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 1, 2025
Merged

docs: Included mermaid diagram for readme.md #60

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b99308a
Included mermaid diagram for readme.md
olsentorfinn May 1, 2025
22d17ff
Update README.md
olsentorfinn May 1, 2025
3a0f7f0
Merge branch 'main' into 59-chore-mermaid-diagram-for-readme
rbarker-dev May 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,24 @@ Project board, which captures the issues in swim lanes. The Project board can on
meaning users who work in more than one org do not have a single location to view all issues. This leads to fragmented
planning and execution.

# How does it work?

```mermaid
%% A · System-Architecture Diagram (≤25 nodes)
flowchart TD
A[CLI Invocation] --> B{version2config.py<br/>Parse flags & env}
B --> C[Validated Config]
C --> D{version2query.py<br/>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<br/>Jinja2 render}
I --> J[_site/index.html]
classDef api fill:#e3f2fd,stroke:#2196f3;
classDef cli fill:#f1f8e9,stroke:#7cb342;
```

# Our Solution
Our python script will query the GitHub API for all issues associated with the appropriate filters provided to the CLI
tool. The output will be a static HTML page showing all issues in swim lanes. This provides a comprehensive overview
Expand Down