Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve getting started for users #340

Merged
merged 10 commits into from
Sep 5, 2023
File renamed without changes
File renamed without changes
2 changes: 1 addition & 1 deletion docs/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Between client requests and the external resources, we have a classical layered
Service and System layers. The System layer is itself responsible to encapsulate the blockchain, database,
external node interfaces and for a SPI (service programing interface). Developers can easily create new implementations of those system service layers.

![architecture_overview](_media/architecture_overview_half.png)
![architecture_overview](_media/architecture/architecture_overview_half.png)

### Blockchain Interface

Expand Down
4 changes: 2 additions & 2 deletions docs/backend.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,13 +39,13 @@ There are two internal nodes workflow and condition.
These nodes are handled by the engine itself, they are visible in the Stack but they can also be visible in Current().
For example if the root workflow starts with another workflow or a condition.

![node diagram](_media/node_workflow.png)
![node diagram](_media/nodes/node_workflow.png)

#### Background node

Successful execution of background node proceeds to the next one without waiting.

![node diagram](_media/background_node_workflow.png)
![node diagram](_media/nodes/background_node_workflow.png)

Error when executing a background node. The entire workflow process stops or moves back to the foreground node and waits for the next user interaction.

Expand Down
2 changes: 1 addition & 1 deletion docs/external_workflow_nodes.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ External workflow nodes are the primary method to extend Proxeus workflow to any
They are implemented as external HTTP servers that interact with the Proxeus Core using a
simple API.

![external_node](_media/external_node_half.png)
![external_node](_media/nodes/external_node_half.png)

During workflow execution, when the state transitions to an external node, the following steps are executed:
* Proxeus Core sends the full workflow state the external node,
Expand Down
Loading