Merge pull request #155 from potassco/documentation

Moved images
potassco · Dec 13, 2023 · 76fe387 · 76fe387
2 parents 1fc64b1 + 2bbd8f3
commit 76fe387
Show file tree

Hide file tree

Showing 31 changed files with 14 additions and 59 deletions.
diff --git a/docs/client.png b/docs/client.png
diff --git a/docs/clinguin/reference.rst b/docs/clinguin/reference.rst
@@ -10,7 +10,7 @@ All components of the diagram are explained in detail in this guide.
 
     In this diagram, operations are marked in gray, states corresponding to sets of facts are depicted in green, and input files appear in red.
 
-.. figure:: ../img/workflow.png
+.. figure:: ../workflow.png
 
 
 ------------------------------------------------------------------------------------
@@ -22,7 +22,7 @@ Structure
 Server
 ******
 
-    .. figure:: ../img/server.png
+    .. figure:: ../server.png
 
     The server is responsible for executing clingo and computing the information required to define the UI. This process unfolds in two distinct steps:
 
@@ -52,7 +52,7 @@ Server
 Client
 ******
 
-    .. figure:: ../img/client.png
+    .. figure:: ../client.png
 
     The client is responsible for rendering the UI and responding to the user's actions.
     When it is loaded, it requests the :ref:`ui-state` from the server.
@@ -80,7 +80,7 @@ Input
 domain-files
 ************
 
-    .. figure:: ../img/domfiles.png
+    .. figure:: ../domfiles.png
 
     The domain-specific ASP encodings that will generate solutions to the problem (including the instance).
     These files will be used by the :ref:`domain-control`.
@@ -90,7 +90,7 @@ domain-files
 ui-files
 ************
 
-    .. figure:: ../img/uifiles.png
+    .. figure:: ../uifiles.png
 
     The encoding that will generate the :ref:`ui-state` using the :ref:`domain-state` as input.
     They are provided when starting the server via the command line in argument ``--ui-files``.
@@ -108,7 +108,7 @@ States are sets of ASP facts that are used to define diferent aspects of the sys
 ui-state
 ********
 
-    .. figure:: ../img/uistate.png
+    .. figure:: ../uistate.png
 
     A User Interface is defined in `clinguin` using the three predicates below.
     These facts are generated by calling clingo with the :ref:`domain-state` and the provided :ref:`ui-files`.
@@ -193,7 +193,7 @@ ui-state
 domain-state
 ************
 
-    .. figure:: ../img/domstate.png
+    .. figure:: ../domstate.png
 
     A set of facts defining the state of the domain, which will be used as input to the :ref:`ui-files`.
     These facts are generated by multiple domain-state constructors defined by the backend. 
@@ -304,7 +304,7 @@ Control
 domain-control
 **************
 
-    .. figure:: ../img/domcontrol.png
+    .. figure:: ../domcontrol.png
 
 
     The *Clingo* control that will be handled by the Backend.
@@ -315,7 +315,7 @@ domain-control
 ui-control
 **************
 
-    .. figure:: ../img/uicontrol.png
+    .. figure:: ../uicontrol.png
 
 
     The *Clingo* control that will be used to compute the :ref:`ui-state` using the :ref:`ui-files`.
@@ -334,7 +334,7 @@ GET
     When the UI is first loaded and in every reload, the client will do a ``GET`` request which will update the UI.
 
 
-    .. figure:: ../img/get.png
+    .. figure:: ../get.png
 
 
 ****
@@ -344,7 +344,7 @@ POST
     When the user triggers as event that is associiated with a ``call`` action, the client will do a ``POST`` request.
     This request will include the selected operations and the context.
 
-    .. figure:: ../img/post.png
+    .. figure:: ../post.png
 
 **********
 Operations
@@ -353,14 +353,14 @@ Operations
     The operations are defined by the backend. These operations will interact with the domain control while performing all the required changes. 
     Each backend will define an available list of operations. These lists can be found in :ref:`Backends`.
 
-    .. figure:: ../img/operation.png
+    .. figure:: ../operation.png
 
 
 ********
 Context
 ********
 
-    .. figure:: ../img/context.png
+    .. figure:: ../context.png
 
 
     The context can be used to store information provided by the user before calling the server. For instance, it can store the input of a text field, or the value of a checkbox. Therefore, it is usefull for creating input forms within the UI. Internally, the context is represented by a dictionary in the client and it can be accesed in three ways.
@@ -430,7 +430,7 @@ Context
 JSON UI
 ********
 
-    .. figure:: ../img/json.png
+    .. figure:: ../json.png
 
 
     The :ref:`ui-state` is represented by a JSON to comunicate between client and server. This JSON is generated in a herachical fashion where each element apears with the following form. 

diff --git a/docs/context.png b/docs/context.png
diff --git a/docs/domcontrol.png b/docs/domcontrol.png
diff --git a/docs/domfiles.png b/docs/domfiles.png
diff --git a/docs/domstate.png b/docs/domstate.png
diff --git a/docs/get.png b/docs/get.png
diff --git a/docs/img/client.png b/docs/img/client.png
diff --git a/docs/img/context.png b/docs/img/context.png
diff --git a/docs/img/domcontrol.png b/docs/img/domcontrol.png
diff --git a/docs/img/domfiles.png b/docs/img/domfiles.png
diff --git a/docs/img/domstate.png b/docs/img/domstate.png
diff --git a/docs/img/get.png b/docs/img/get.png
diff --git a/docs/img/input.png b/docs/img/input.png
diff --git a/docs/img/json.png b/docs/img/json.png
diff --git a/docs/img/operation.png b/docs/img/operation.png
diff --git a/docs/img/post.png b/docs/img/post.png
diff --git a/docs/img/server.png b/docs/img/server.png
diff --git a/docs/img/uicontrol.png b/docs/img/uicontrol.png
diff --git a/docs/img/uifiles.png b/docs/img/uifiles.png
diff --git a/docs/img/uistate.png b/docs/img/uistate.png
diff --git a/docs/img/workflow.png b/docs/img/workflow.png
diff --git a/docs/input.png b/docs/input.png
diff --git a/docs/json.png b/docs/json.png
diff --git a/docs/operation.png b/docs/operation.png
diff --git a/docs/post.png b/docs/post.png
diff --git a/docs/server.png b/docs/server.png
diff --git a/docs/uicontrol.png b/docs/uicontrol.png
diff --git a/docs/uifiles.png b/docs/uifiles.png
diff --git a/docs/uistate.png b/docs/uistate.png
diff --git a/docs/workflow.png b/docs/workflow.png