An open API service indexing awesome lists of open source software.

https://github.com/andifalk/architecture-docs

Sample architecture docs
https://github.com/andifalk/architecture-docs

Last synced: about 1 month ago
JSON representation

Sample architecture docs

Awesome Lists containing this project

README

        

# Architecture Docs

Sample architecture documentation based on [ARC42](https://arc42.org) asciidoc template including support for UML diagrams with [PlantUML](https://plantuml.com).

## Prerequisites

You need to install GraphViz first to render UML diagrams.
See [GraphViz Dot](https://plantuml.com/graphviz-dot) for details.

## Build docs

Just perform a `./mvnw clean package`to generate the PDF and HTML5 documentation file.