Skip to content

Commit

Permalink
Added a Mermaid sample sequence diagram
Browse files Browse the repository at this point in the history
  • Loading branch information
dassiorleando committed Dec 13, 2024
1 parent d17b9b2 commit 5b0a1ba
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 2 deletions.
19 changes: 18 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,25 @@
# Software Architecture Documentation Template [![Hits](https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https://dassiorleando.github.io/software-architecture-documentation-template/&count_bg=%2379C83D&title_bg=%23555555&icon=&icon_color=%23E7E7E7&title=hits&edge_flat=false)](https://dassiorleando.github.io/software-architecture-documentation-template/)


You can access the generated documentation [here (demo)](https://dassiorleando.github.io/software-architecture-documentation-template/), it's based on a sample you can download at [arc42.org](https://arc42.org/download).

<!--- this diagram will show in GitHub-like Markdown viewer -->
```mermaid
sequenceDiagram
title Sample Mermaid Diagram
box Purple Alice & John
participant A
participant J
end
box Another Group
participant B
participant C
end
A->>J: Hello John, how are you?
J->>A: Great!
A->>B: Hello Bob, how is Charley?
B->>C: Hello Charley, how are you?
```

## Capabilities

* `Arc42` - the documentation template in place, [link](https://arc42.org/).
Expand Down
16 changes: 16 additions & 0 deletions docs/diagrams/mermaid-sequence-diagram.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
```mermaid
sequenceDiagram
title Sample Mermaid Diagram
box Purple Alice & John
participant A
participant J
end
box Another Group
participant B
participant C
end
A->>J: Hello John, how are you?
J->>A: Great!
A->>B: Hello Bob, how is Charley?
B->>C: Hello Charley, how are you?
```
3 changes: 2 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
# Software Architecture Documentation Template&nbsp;[![Hits](https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https://dassiorleando.github.io/software-architecture-documentation-template/&count_bg=%2379C83D&title_bg=%23555555&icon=&icon_color=%23E7E7E7&title=hits&edge_flat=false)](https://dassiorleando.github.io/software-architecture-documentation-template/)


You can access the generated documentation [here (demo)](https://dassiorleando.github.io/software-architecture-documentation-template/), it's based on a sample you can download at [arc42.org](https://arc42.org/download).

{% include 'diagrams/mermaid-sequence-diagram.md' %}

## Capabilities

* `Arc42` - the documentation template in place, [link](https://arc42.org/).
Expand Down

0 comments on commit 5b0a1ba

Please sign in to comment.