added docs

Author: lelepado01

README.md

@@ -70,3 +70,7 @@ python run.py test.yaml
 - output_graph.png: Graph visualization of tasks and data flow
 
 ![output_graph](example/output_graph.png)
+
+### Documentation
+
+For detailed information, please refer to the [Documentation](https://hpci-lab.github.io/y2Graph/)

docs/src/example_images.md

@@ -0,0 +1,10 @@
+
+### Example with Images
+
+![ExampleWithImages](./assets/images.png)
+
+<div style="display: flex; justify-content: center; gap: 10px; margin-top: 20px;">
+    <a href=".readme.md" style="text-decoration: none; background-color: #006269; color: white; padding: 10px 20px; border-radius: 5px; font-weight: bold; transition: 0.3s;">← Prev</a>
+    <a href="." style="text-decoration: none; background-color: #006269; color: white; padding: 10px 20px; border-radius: 5px; font-weight: bold; transition: 0.3s;">🏠 Home</a>
+    <a href="installation.md" style="text-decoration: none; background-color: #006269; color: white; padding: 10px 20px; border-radius: 5px; font-weight: bold; transition: 0.3s;">Next →</a>
+</div>

docs/src/example_join.md

@@ -1,8 +1,15 @@
 
-### Simple Example
+### Joined Example
 
+![ExampleJoined](./assets/joined.png)
 
 
+This example allows to specify multiple yaml files, and to connect the jsons into a single file, as well as creating a common graph representation. This feature uses UIDs to identify shared elements which can be connected.  
+
+All data files are present in the `example_join` subdirectory. 
+
+The files `test1.yaml` and `test2.yaml` are used as source, and the program looks for ids the inputs and outputs fields to connect as common elements. 
+
 <div style="display: flex; justify-content: center; gap: 10px; margin-top: 20px;">
     <a href=".readme.md" style="text-decoration: none; background-color: #006269; color: white; padding: 10px 20px; border-radius: 5px; font-weight: bold; transition: 0.3s;">← Prev</a>
     <a href="." style="text-decoration: none; background-color: #006269; color: white; padding: 10px 20px; border-radius: 5px; font-weight: bold; transition: 0.3s;">🏠 Home</a>

docs/src/example_simple.md

@@ -1,7 +1,13 @@
 
-### Joined Example
+### Simple Example
 
+This example allows to convert from a yaml to W3C ProvJSON and the respective graph form. 
 
+All data files are present in the `example_simple` subdirectory. 
+
+The file `test.yaml` is used as source, and the program generates fist a W3C Prov JSON file, and then converts it to pdf, svg or png visualization. 
+
+![ExampleSimple](./assets/simple.png)
 
 <div style="display: flex; justify-content: center; gap: 10px; margin-top: 20px;">
     <a href=".examples.md" style="text-decoration: none; background-color: #006269; color: white; padding: 10px 20px; border-radius: 5px; font-weight: bold; transition: 0.3s;">← Prev</a>

docs/src/examples.md

@@ -4,6 +4,7 @@
 A set of 5 examples are provided: 
 - [Simple](./example_simple.md)
 - [Joined](./example_join.md)
+- [Images](./example_images.md)
 
 <div style="display: flex; justify-content: center; gap: 10px; margin-top: 20px;">
     <a href=".usage.md" style="text-decoration: none; background-color: #006269; color: white; padding: 10px 20px; border-radius: 5px; font-weight: bold; transition: 0.3s;">← Prev</a>

docs/src/usage.md

@@ -1,10 +1,17 @@
 
 ### Usage
 
+Currently, two usage modalities are available: 
+
+The former simply allows to convert from a yaml to W3C ProvJSON and the respective graph form: 
 
 ```bash
 python run.py example_simple/test1.yaml example_simple/test2.yaml --join -j combined.json -o combined.pdf
+```
 
+The latter allows to specify multiple yaml files, and to connect the jsons into a single file, as well as creating a common graph representation. This feature uses UIDs to identify shared elements which can be connected.  
+
+```bash
 python run.py example_simple/test.yaml -j simple.json -o simple.pdf
 ```