Added Dynamo documentation to the repo

opencirclesolutions · Aug 25, 2023 · 7a00d56 · 7a00d56
1 parent f962797
commit 7a00d56
Show file tree

Hide file tree

Showing 19 changed files with 5,668 additions and 9 deletions.
diff --git a/README.md → README.adoc b/README.md → README.adoc
@@ -1,16 +1,19 @@
-# Dynamo
+= Dynamo
+
 The Dynamo Web Application Accelerator is a software development framework initially developed by Open Circle Solutions that aims to increase productivity by using design principles such as convention over configuration, model-driven development and DRY (don’t repeat yourself).
 
 At the core of Dynamo is the concept of the Entity Model. The Entity Model is defined as the model describes the attributes and behaviour of an entity (or domain object) in your application. This entity model can then be used as the basis for creating forms, tables, search screens etc. 
 
 The Entity Model of an entity can be automatically generated based on the properties of the attribute model (using sensible defaults as described by the convention over configuration principle) and can further be modified by using attributes and message bundle overwrites. The main goal is to reduce the amount of (boilerplate) code required to perform common actions like creating search screens and edit forms.
 
-Complementing the Entity Model is a set of user interface components (widgets) that can be used to quickly construct screens for common use cases, and a number of base classes for the Data Access and Service layers. 
-The  Framework is built around a number of proven and highly productive set of technologies:
-*	Vaadin as the user interface framework
-*	Spring as the application framework
-*	JPA2 for ORM
-*	QueryDSL for type-safe query generation
-*	Apache Camel for integration
+Complementing the Entity Model is a set of user interface components (widgets) that can be used to quickly construct screens for common use cases, and a number of base classes for the Data Access and Service layers.
+The Framework is built around a number of proven and highly productive set of technologies:
+* Vaadin as the user interface framework
+* Spring as the application framework
+* JPA2 for ORM
+* QueryDSL for type-safe query generation
+* Apache Camel for integration
+
+Documentation of Dynamo can be found xref:dynamo-documentation/index.adoc[here].
 
-Interested in contributing? Check our [wiki](https://github.com/opencirclesolutions/dynamo/wiki)!
+Interested in contributing? Check our https://github.com/opencirclesolutions/dynamo/wiki[wiki]!
diff --git a/dynamo-documentation/index.adoc b/dynamo-documentation/index.adoc
diff --git a/dynamo-documentation/media/image10.png b/dynamo-documentation/media/image10.png
diff --git a/dynamo-documentation/media/image11.png b/dynamo-documentation/media/image11.png
diff --git a/dynamo-documentation/media/image12.png b/dynamo-documentation/media/image12.png
diff --git a/dynamo-documentation/media/image13.png b/dynamo-documentation/media/image13.png
diff --git a/dynamo-documentation/media/image14.png b/dynamo-documentation/media/image14.png
diff --git a/dynamo-documentation/media/image15.png b/dynamo-documentation/media/image15.png
diff --git a/dynamo-documentation/media/image16.png b/dynamo-documentation/media/image16.png
diff --git a/dynamo-documentation/media/image17.png b/dynamo-documentation/media/image17.png
diff --git a/dynamo-documentation/media/image3.png b/dynamo-documentation/media/image3.png
diff --git a/dynamo-documentation/media/image4.png b/dynamo-documentation/media/image4.png
diff --git a/dynamo-documentation/media/image5.png b/dynamo-documentation/media/image5.png
diff --git a/dynamo-documentation/media/image6.png b/dynamo-documentation/media/image6.png
diff --git a/dynamo-documentation/media/image7.png b/dynamo-documentation/media/image7.png
diff --git a/dynamo-documentation/media/image8.png b/dynamo-documentation/media/image8.png
diff --git a/dynamo-documentation/media/image9.png b/dynamo-documentation/media/image9.png
diff --git a/dynamo-documentation/media/logo-dynamo.png b/dynamo-documentation/media/logo-dynamo.png
diff --git a/dynamo-documentation/media/logo-opencirclesolutions.svg b/dynamo-documentation/media/logo-opencirclesolutions.svg