From 8f73ddb6abd8d3c9977a5a84d50ac2ad89a8f82c Mon Sep 17 00:00:00 2001 From: Milan Milanovic Date: Tue, 25 Jun 2024 12:59:16 +0200 Subject: [PATCH] Update text --- README.md | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index d6214d8..5629c47 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Software Architecture Documentation with arc42 and C4 Model -This repository provides an example of generating architecture documentation using the [arc42 template](https://arc42.org/) and the [C4 model](https://c4model.com/), with the help of Structurizr CLI and Asciidoctor. The documentation includes various architectural views and diagrams, generated automatically using Docker and Docker Compose locally, or by using GitHub pages. +This repository provides an example of generating architecture documentation using the [arc42 template](https://arc42.org/) and the [C4 model](https://c4model.com/), with the help of Structurizr CLI and Asciidoctor. The documentation includes various architectural views and diagrams, generated automatically using Docker and Docker Compose locally, or by using GitHub pages or Confluence. The complete process is explained in details in [the text](https://newsletter.techworld-with-milan.com/p/documenting-software-architectures). @@ -38,17 +38,21 @@ The repository demonstrates how to: ``` architecture-docs/ -├── src/ # Source files for documentation -│ └── docs/ # Documentation source directory -│ ├── asciidoc/ # AsciiDoc files -│ │ ├── sections/ # Individual section files for arc42 template +├── src/ # Source files for documentation +│ └── docs/ # Documentation source directory +│ ├── asciidoc/ # AsciiDoc files +│ │ ├── sections/ # Individual section files for arc42 template │ │ │ ├── 01_introduction_and_goals.adoc │ │ │ ├── ... -│ │ └── index.adoc # Main AsciiDoc file including all sections -│ ├── structurizr/ # Structurizr DSL files and generated PlantUML diagrams +│ │ └── index.adoc # Main AsciiDoc file including all sections +│ ├── structurizr/ # Structurizr DSL files and generated PlantUML diagrams │ │ ├── structurizr.dsl │ │ ├── structurizr.properties │ │ ├── ... Generated PUML files +├── .github / # GitHub Workflows + └── docs/ +│ ├── deploy-confluence.yaml # Deploy to Confluence Workflow +│ └── deploy-docs.yaml # Deploy to GitHub Pages Workflow ``` ## Usage