Skip to content

Commit e4e7495

Browse files
committed
docs: Add structurizr-based architecture documentation.
Set up comprehensive architecture documentation using Structurizr DSL. Add application and deployment diagram workspaces with detailed component views. Integrate architecture docs into main documentation index. Signed-off-by: andreidanila1 <[email protected]>
1 parent 0a45cd0 commit e4e7495

File tree

8 files changed

+5721
-0
lines changed

8 files changed

+5721
-0
lines changed

.github/workflows/generate_doc.yml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,13 +45,24 @@ jobs:
4545
echo "test_report_folder=$TEST_REPORT_FOLDER" >> "$GITHUB_ENV"
4646
# python3 test_report_generator.py ../testing_results/ tests/test_report/ "${{ github.sha }}"
4747
48+
- name: Setup Java for Structurizr
49+
uses: actions/setup-java@v4
50+
with:
51+
distribution: 'temurin'
52+
java-version: '17'
53+
4854
- name: Build doc
4955
working-directory: docs
5056
run: |
5157
python3 extract_macros.py ../ user_guide/preferences_table.rst
5258
export ADOC_DOC_VERSION=${{ github.ref_name }}
5359
make html SPHINXOPTS='-W --keep-going'
5460
61+
- name: Build Structurizr diagrams
62+
working-directory: docs/architecture/diagrams
63+
run: |
64+
./build-structurizr.sh
65+
5566
- name: Store the generated doc
5667
uses: actions/upload-artifact@v4
5768
with:

docs/architecture/.gitignore

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
diagrams/_build
2+
diagrams/app_diagrams/.structurizr
3+
diagrams/deployment_diagrams/.structurizr
4+
diagrams/lib
5+
diagrams/structurizr*

docs/architecture/diagrams/app_diagrams/workspace.dsl

Lines changed: 700 additions & 0 deletions
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)