Feature/Extended documentation. (#17)

othercodes · web-flow · commit 00b21ac23887 · 2021-02-10T22:26:36.000+01:00
diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml
@@ -2,6 +2,7 @@ name: Documentation
 
 on:
   pull_request:
+    branches: [ main ]
     types: [ closed ]
 
 jobs:
diff --git a/README.md b/README.md
@@ -90,6 +90,8 @@ Check this small example of the usage:
 $response = $queryBus->ask(new GetUserQuery('some-uuid-value'));
 ```
 
+Check the [wiki](https://github.com/othercodes/ComplexHeart/wiki) for more detailed examples.
+
 ## References
 
 - [Pro Codely TV](https://pro.codely.tv/library/)
diff --git a/wiki/Domain-Modeling-Aggregates.md b/wiki/Domain-Modeling-Aggregates.md
diff --git a/wiki/Domain-Modeling-Entities.md b/wiki/Domain-Modeling-Entities.md
diff --git a/wiki/Domain-Modeling-Value-Objects.md b/wiki/Domain-Modeling-Value-Objects.md
@@ -1,4 +1,3 @@
-# Value Objects
 
 ```php
 use OtherCode\ComplexHeart\Domain\Contracts\ValueObject;
diff --git a/wiki/Domain-Modeling.md b/wiki/Domain-Modeling.md
@@ -1,4 +1,4 @@
-## Domain Modeling: Aggregates, Entities and Value Objects
+## How to model the domain
 
 Complex Heart allows you to model your domain Aggregates, Entities, and Value Objects using a set of traits. Great, but
 why traits and not classes? Well, sometimes you have some kind of inheritance in your classes. Being forced to use a
diff --git a/wiki/Home.md b/wiki/Home.md
@@ -1,2 +1 @@
-# Home 
 
diff --git a/wiki/Service-Bus.md b/wiki/Service-Bus.md
diff --git a/wiki/_Sidebar.md b/wiki/_Sidebar.md
@@ -1,7 +1,7 @@
 - [Home](Home)
-- [Domain Modeling](DomainModeling)
-  - Aggregates
-  - Entities
-  - [Value Objects](DomainModeling_ValueObjects)
-- [Service Bus](Service Bus)
+- [Domain Modeling](Domain-Modeling)
+  - [Aggregates](Domain-Modeling-Aggregates)
+  - [Entities](Domain-Modeling-Entities)
+  - [Value Objects](Domain-Modeling-Value-Objects)
+- [Service Bus](Service-Bus)
 - Criteria Pattern

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`		`-# Value Objects`
`2`	`1`
`3`	`2`	```php
`4`	`3`	`use OtherCode\ComplexHeart\Domain\Contracts\ValueObject;`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-## Domain Modeling: Aggregates, Entities and Value Objects`
	`1`	`+## How to model the domain`
`2`	`2`
`3`	`3`	`Complex Heart allows you to model your domain Aggregates, Entities, and Value Objects using a set of traits. Great, but`
`4`	`4`	`why traits and not classes? Well, sometimes you have some kind of inheritance in your classes. Being forced to use a`