diff --git a/README.adoc b/README.adoc index 4003cbe..5b6441f 100644 --- a/README.adoc +++ b/README.adoc @@ -5,7 +5,7 @@ This example shows how to use https://arc42.org/[arc42] in combination with the https://c4model.com/[C4 model] with the Documentation as Code technique. -It shows how to use the techniques described in https://www.workingsoftware.dev/software-architecture-documentation-the-ultimate-guide/[The ultimate Guide to Software Architecture Documentation]. +It shows how to use the techniques described in https://www.workingsoftware.dev/software-architecture-documentation-the-ultimate-guide/[The Ultimate Guide to Software Architecture Documentation]. Check out the deployed https://bitsmuggler.github.io/arc42-c4-software-architecture-documentation-example/[example HTML build] provided on GitHub Pages. @@ -29,8 +29,7 @@ Go through the following steps: * https://kroki.io[Kroki] to generate diagrams * https://github.com/npryce/adr-tools[adr-tools] to generate and manage Architecture Decision Records (ADRs) -For more tech inspiration take a look at the https://www.workingsoftware.dev/documentation-as-code-tools[Documentation as Code Technology Radar] - +For more tech inspiration take a look at the https://www.workingsoftware.dev/documentation-as-code-tools[Documentation as Code Technology Radar]. == Prerequisites