extended tech documentation

vondacho · May 11, 2023 · 846468c · 846468c
1 parent 5e8abbf
commit 846468c
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git 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
@@ -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).