-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
This is where the diagrams will be generated. A readme is included for explanatory purposes.
- Loading branch information
1 parent
4cbac94
commit b6b1390
Showing
1 changed file
with
18 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
Diagrams in this directory are auto-generated. | ||
Any PR that makes changes in the `docs/workspace.dsl` file in this repo will | ||
trigger a GitHub action that updates the diagrams. | ||
This will add a new commit to the PR. | ||
|
||
# Contributing | ||
|
||
If you want to edit the `workspace.dsl` and see your changes reflected during | ||
testing you have two options: | ||
|
||
1. The [online editor](https://structurizr.com/dsl) from Structurizr | ||
2. The [CLI](https://docs.structurizr.com/cli) from Structurizr | ||
|
||
The diagrams are built according to the [C4 model](https://c4model.com/). | ||
This allows architectural diagrams to be constructed at different levels of abstraction from a single `workspace.dsl`. | ||
|
||
If contributing to the diagrams you should be familiar with the C4 Model. | ||
Any change you make could potentially impact multiple diagrams. |