From 846468ce9e6b9321f5fe19927c1dfa6300137f69 Mon Sep 17 00:00:00 2001 From: Olivier von Dach Date: Thu, 11 May 2023 14:26:57 +0200 Subject: [PATCH] extended tech documentation --- src/doc/mkdocs.yml | 1 + src/doc/tech/miscellaneous.md | 9 +++++++++ 2 files changed, 10 insertions(+) create mode 100644 src/doc/tech/miscellaneous.md diff --git a/src/doc/mkdocs.yml b/src/doc/mkdocs.yml index 635a5b5..a3bbbd2 100644 --- a/src/doc/mkdocs.yml +++ b/src/doc/mkdocs.yml @@ -10,6 +10,7 @@ nav: - API: api/ - Architecture: architecture.md - Testing: testing.md + - Miscellaneous: miscellaneous.md plugins: - search diff --git a/src/doc/tech/miscellaneous.md b/src/doc/tech/miscellaneous.md new file mode 100644 index 0000000..982ff8b --- /dev/null +++ b/src/doc/tech/miscellaneous.md @@ -0,0 +1,9 @@ +# Miscellaneous + +## Technical documentation +Build technical documentation with `./gradlew allureAggregateReport plantumlAll generateSwaggerUI mkdocsBuild`. + +## AppMap resources +Generate AppMap resources with `./gradlew appmap test`. + +View your local AppMap resources following [this tutorial](https://github.com/vondacho/appmap-viewer#getting-started). \ No newline at end of file