Improve getting started for users (#340)

* handbook link The handbook button displayed after the registration phase of the application and the link in the help/support section of the application have been updated. * architecture created and related images moved to this folder * nodes folder nodes folder created and related images moved to this folder * handbook images images renamed * Update handbook.md * hamdbook img moved to media folder There are some photos that I couldn't categorize, we can categorize them later if needed. * Img file location fixed * sidebar made more accessible * about and sidebar * Footer added Mail, address and github
ProxeusApp · Sep 5, 2023 · b005d9f · b005d9f
1 parent 40f2c5c
commit b005d9f
Show file tree

Hide file tree

Showing 69 changed files with 90 additions and 82 deletions.
diff --git a/docs/_media/architecture.png → docs/_media/architecture/architecture.png b/docs/_media/architecture.png → docs/_media/architecture/architecture.png
diff --git a/docs/_media/architecture_overview.png → ...ia/architecture/architecture_overview.png b/docs/_media/architecture_overview.png → ...ia/architecture/architecture_overview.png
diff --git a/docs/_media/architecture_overview_half.png → ...chitecture/architecture_overview_half.png b/docs/_media/architecture_overview_half.png → ...chitecture/architecture_overview_half.png
diff --git a/...mplete Handbook_html_30ebd5a287e6c904.gif → ...mplete Handbook_html_30ebd5a287e6c904.gif b/...mplete Handbook_html_30ebd5a287e6c904.gif → ...mplete Handbook_html_30ebd5a287e6c904.gif
diff --git a/...mplete Handbook_html_ead9a2bf0849694e.gif → ...mplete Handbook_html_ead9a2bf0849694e.gif b/...mplete Handbook_html_ead9a2bf0849694e.gif → ...mplete Handbook_html_ead9a2bf0849694e.gif
diff --git a/...mplete Handbook_html_2cf30d5758e4a4fa.png → docs/_media/handbook/admin-panel.png b/...mplete Handbook_html_2cf30d5758e4a4fa.png → docs/_media/handbook/admin-panel.png
diff --git a/...mplete Handbook_html_2f5cac16d403f61b.png → docs/_media/handbook/api/api-1.png b/...mplete Handbook_html_2f5cac16d403f61b.png → docs/_media/handbook/api/api-1.png
diff --git a/...mplete Handbook_html_f622e65eb6e6449c.png → docs/_media/handbook/api/api-2.png b/...mplete Handbook_html_f622e65eb6e6449c.png → docs/_media/handbook/api/api-2.png
diff --git a/...mplete Handbook_html_10299e76126cc024.png → docs/_media/handbook/condition.png b/...mplete Handbook_html_10299e76126cc024.png → docs/_media/handbook/condition.png
diff --git a/...mplete Handbook_html_4225235e26b8c178.png → docs/_media/handbook/custom-nodes-2.png b/...mplete Handbook_html_4225235e26b8c178.png → docs/_media/handbook/custom-nodes-2.png
diff --git a/...mplete Handbook_html_951d02a5e7f5dc31.png → docs/_media/handbook/custom-nodes.png b/...mplete Handbook_html_951d02a5e7f5dc31.png → docs/_media/handbook/custom-nodes.png
diff --git a/...mplete Handbook_html_5658bd1d0e8a3e71.png → docs/_media/handbook/data-1.png b/...mplete Handbook_html_5658bd1d0e8a3e71.png → docs/_media/handbook/data-1.png
diff --git a/...mplete Handbook_html_6544c8b9845e4ce8.png → docs/_media/handbook/data-2.png b/...mplete Handbook_html_6544c8b9845e4ce8.png → docs/_media/handbook/data-2.png
diff --git a/...mplete Handbook_html_8649382b98149ec0.png → docs/_media/handbook/data-3.png b/...mplete Handbook_html_8649382b98149ec0.png → docs/_media/handbook/data-3.png
diff --git a/...mplete Handbook_html_5cb7ff81c6e55e5e.png → docs/_media/handbook/documents.png b/...mplete Handbook_html_5cb7ff81c6e55e5e.png → docs/_media/handbook/documents.png
diff --git a/...mplete Handbook_html_c6dbc4f60fe085d4.png → docs/_media/handbook/downloads.png b/...mplete Handbook_html_c6dbc4f60fe085d4.png → docs/_media/handbook/downloads.png
diff --git a/...mplete Handbook_html_3f41852b7dfa724d.png → docs/_media/handbook/forms/forms-1.png b/...mplete Handbook_html_3f41852b7dfa724d.png → docs/_media/handbook/forms/forms-1.png
diff --git a/...mplete Handbook_html_f2247b1e55d57403.png → docs/_media/handbook/forms/forms-10.png b/...mplete Handbook_html_f2247b1e55d57403.png → docs/_media/handbook/forms/forms-10.png
diff --git a/...mplete Handbook_html_ed735f78a5c0be77.png → docs/_media/handbook/forms/forms-2.png b/...mplete Handbook_html_ed735f78a5c0be77.png → docs/_media/handbook/forms/forms-2.png
diff --git a/...mplete Handbook_html_bd6b023a95f49a54.png → docs/_media/handbook/forms/forms-3.png b/...mplete Handbook_html_bd6b023a95f49a54.png → docs/_media/handbook/forms/forms-3.png
diff --git a/...mplete Handbook_html_b6074b169d306295.png → docs/_media/handbook/forms/forms-4.png b/...mplete Handbook_html_b6074b169d306295.png → docs/_media/handbook/forms/forms-4.png
diff --git a/...omplete Handbook_html_7c16ff586c91d22.png → docs/_media/handbook/forms/forms-5.png b/...omplete Handbook_html_7c16ff586c91d22.png → docs/_media/handbook/forms/forms-5.png
diff --git a/...mplete Handbook_html_8f8c4dee1c7f180e.png → docs/_media/handbook/forms/forms-6.png b/...mplete Handbook_html_8f8c4dee1c7f180e.png → docs/_media/handbook/forms/forms-6.png
diff --git a/...mplete Handbook_html_7082734f41d7a205.png → docs/_media/handbook/forms/forms-7.png b/...mplete Handbook_html_7082734f41d7a205.png → docs/_media/handbook/forms/forms-7.png
diff --git a/...mplete Handbook_html_c9ff17083ce623b0.png → docs/_media/handbook/forms/forms-9.png b/...mplete Handbook_html_c9ff17083ce623b0.png → docs/_media/handbook/forms/forms-9.png
diff --git a/...mplete Handbook_html_d241ff7211167f3a.png → docs/_media/handbook/formula/formula-2.png b/...mplete Handbook_html_d241ff7211167f3a.png → docs/_media/handbook/formula/formula-2.png
diff --git a/...mplete Handbook_html_8a570ce7f4d583b2.png → docs/_media/handbook/formula/formula.png b/...mplete Handbook_html_8a570ce7f4d583b2.png → docs/_media/handbook/formula/formula.png
diff --git a/...mplete Handbook_html_63e1e3204a60f7f8.png → docs/_media/handbook/logo.png b/...mplete Handbook_html_63e1e3204a60f7f8.png → docs/_media/handbook/logo.png
diff --git a/...mplete Handbook_html_7be2670d2f1892cb.png → .../handbook/multilingual/multilingual-1.png b/...mplete Handbook_html_7be2670d2f1892cb.png → .../handbook/multilingual/multilingual-1.png
diff --git a/...mplete Handbook_html_93d98c7a37d04dc3.png → .../handbook/multilingual/multilingual-2.png b/...mplete Handbook_html_93d98c7a37d04dc3.png → .../handbook/multilingual/multilingual-2.png
diff --git a/...mplete Handbook_html_a1d0a25615f373f4.png → .../handbook/multilingual/multilingual-3.png b/...mplete Handbook_html_a1d0a25615f373f4.png → .../handbook/multilingual/multilingual-3.png
diff --git a/...mplete Handbook_html_463f7d37dd1f0f7e.png → .../handbook/multilingual/multilingual-4.png b/...mplete Handbook_html_463f7d37dd1f0f7e.png → .../handbook/multilingual/multilingual-4.png
diff --git a/...mplete Handbook_html_b0d27088acfc9ea1.png → ...ng-signatures/requesting-signatures-1.png b/...mplete Handbook_html_b0d27088acfc9ea1.png → ...ng-signatures/requesting-signatures-1.png
diff --git a/...mplete Handbook_html_f29c3f30ee6d87a2.png → ...ng-signatures/requesting-signatures-2.png b/...mplete Handbook_html_f29c3f30ee6d87a2.png → ...ng-signatures/requesting-signatures-2.png
diff --git a/...mplete Handbook_html_6061bcac26f7fc4a.png → ...ng-signatures/requesting-signatures-3.png b/...mplete Handbook_html_6061bcac26f7fc4a.png → ...ng-signatures/requesting-signatures-3.png
diff --git a/...mplete Handbook_html_d007d01a1f3c3208.png → ...ng-signatures/requesting-signatures-4.png b/...mplete Handbook_html_d007d01a1f3c3208.png → ...ng-signatures/requesting-signatures-4.png
diff --git a/...mplete Handbook_html_7c96d6635102e938.png → ..._media/handbook/templates/templates-1.png b/...mplete Handbook_html_7c96d6635102e938.png → ..._media/handbook/templates/templates-1.png
diff --git a/...omplete Handbook_html_64cf037526a23d7.png → ..._media/handbook/templates/templates-2.png b/...omplete Handbook_html_64cf037526a23d7.png → ..._media/handbook/templates/templates-2.png
diff --git a/...mplete Handbook_html_71ee1bf264a4edea.png → ..._media/handbook/templates/templates-3.png b/...mplete Handbook_html_71ee1bf264a4edea.png → ..._media/handbook/templates/templates-3.png
diff --git a/...mplete Handbook_html_90e0d496413daf75.png → ..._media/handbook/templates/templates-4.png b/...mplete Handbook_html_90e0d496413daf75.png → ..._media/handbook/templates/templates-4.png
diff --git a/...mplete Handbook_html_9375dbc8240de8f6.png → ..._media/handbook/templates/templates-5.png b/...mplete Handbook_html_9375dbc8240de8f6.png → ..._media/handbook/templates/templates-5.png
diff --git a/...mplete Handbook_html_f74a14eaebbef02b.png → ..._media/handbook/templates/templates-6.png b/...mplete Handbook_html_f74a14eaebbef02b.png → ..._media/handbook/templates/templates-6.png
diff --git a/...mplete Handbook_html_c928046a2a552f00.png → ..._media/handbook/templates/templates-7.png b/...mplete Handbook_html_c928046a2a552f00.png → ..._media/handbook/templates/templates-7.png
diff --git a/...mplete Handbook_html_ad8c3d09bed27d94.png → docs/_media/handbook/verification-1.png b/...mplete Handbook_html_ad8c3d09bed27d94.png → docs/_media/handbook/verification-1.png
diff --git a/...mplete Handbook_html_4941424111de63ee.png → docs/_media/handbook/verification-2.png b/...mplete Handbook_html_4941424111de63ee.png → docs/_media/handbook/verification-2.png
diff --git a/...mplete Handbook_html_64aa240a167179fa.png → ..._media/handbook/workflows/workflows-1.png b/...mplete Handbook_html_64aa240a167179fa.png → ..._media/handbook/workflows/workflows-1.png
diff --git a/...mplete Handbook_html_ce291de963f4a5c7.png → ..._media/handbook/workflows/workflows-2.png b/...mplete Handbook_html_ce291de963f4a5c7.png → ..._media/handbook/workflows/workflows-2.png
diff --git a/...mplete Handbook_html_5481d85d82acc650.png → ..._media/handbook/workflows/workflows-3.png b/...mplete Handbook_html_5481d85d82acc650.png → ..._media/handbook/workflows/workflows-3.png
diff --git a/...mplete Handbook_html_248280e3a19f5674.png → ..._media/handbook/workflows/workflows-5.png b/...mplete Handbook_html_248280e3a19f5674.png → ..._media/handbook/workflows/workflows-5.png
diff --git a/...mplete Handbook_html_e1ea58a054e536e0.png → ..._media/handbook/workflows/workflows-6.png b/...mplete Handbook_html_e1ea58a054e536e0.png → ..._media/handbook/workflows/workflows-6.png
diff --git a/...mplete Handbook_html_d7693cee8e9aac78.png → ..._media/handbook/workflows/workflows-7.png b/...mplete Handbook_html_d7693cee8e9aac78.png → ..._media/handbook/workflows/workflows-7.png
diff --git a/...mplete Handbook_html_7139fb3de33c357a.png → ..._media/handbook/workflows/workflows-9.png b/...mplete Handbook_html_7139fb3de33c357a.png → ..._media/handbook/workflows/workflows-9.png
diff --git a/docs/_media/background_node_workflow.png → ..._media/nodes/background_node_workflow.png b/docs/_media/background_node_workflow.png → ..._media/nodes/background_node_workflow.png
diff --git a/docs/_media/external_node.png → docs/_media/nodes/external_node.png b/docs/_media/external_node.png → docs/_media/nodes/external_node.png
diff --git a/docs/_media/external_node_half.png → docs/_media/nodes/external_node_half.png b/docs/_media/external_node_half.png → docs/_media/nodes/external_node_half.png
diff --git a/docs/_media/external_node_twothird.png → docs/_media/nodes/external_node_twothird.png b/docs/_media/external_node_twothird.png → docs/_media/nodes/external_node_twothird.png
diff --git a/docs/_media/node_workflow.png → docs/_media/nodes/node_workflow.png b/docs/_media/node_workflow.png → docs/_media/nodes/node_workflow.png
diff --git a/docs/_media/xes_payment_sequence_diagram.png → ...ia/nodes/xes_payment_sequence_diagram.png b/docs/_media/xes_payment_sequence_diagram.png → ...ia/nodes/xes_payment_sequence_diagram.png
diff --git a/docs/_media/xes_payment_state_model.png → .../_media/nodes/xes_payment_state_model.png b/docs/_media/xes_payment_state_model.png → .../_media/nodes/xes_payment_state_model.png
diff --git a/docs/_sidebar.md b/docs/_sidebar.md
@@ -1,5 +1,9 @@
 - [![logo](_media/proxeus_logo.svg)](https://proxeus.org)
 
+
+- Proxeus Association
+    - [About](about.md)
+
 - Getting started
 
     - [Quick start](quickstart.md)

diff --git a/docs/about.md b/docs/about.md
@@ -3,7 +3,7 @@
 The association is the governing body responsible for the maintenance and development of the Proxeus software. We also aim to encourage innovation and evangelize the project by launching and supporting community initiatives as well as creating synergies and partnerships with relevant community projects. 
 
 Governance
-----------
+==========
 
 The Association is working to give the project a decentralized structure to allow our members to propose guidance on the software. Our mission is to make the Proxeus software the 'WordPress' of the blockchain - in other words, to democratize access, and lower the costs of deployment of small blockchain applications.
 
@@ -12,12 +12,12 @@ Some of the benefits of getting involved with the Association, is the ability to
 See also the [Contributing](contributing) section, and visit our [Community Forum](https://github.com/ProxeusApp/community/discussions) if you have any questions about the project - or write to us at [email protected]
 
 Statutes
---------
+========
 
 Proxeus Association is a non-profit association governed by the present statutes and, secondly, by Articles 60 et seq. of the Swiss Civil Code. It is politically neutral, and non-denominational.
 
 OVERVIEW
---------
+========
 
 ### Article 2
 
@@ -26,7 +26,7 @@ OVERVIEW
 -   Duration: The Association shall be of unlimited duration.
 
 GOALS
------
+=====
 
 ### Article 3
 
@@ -41,7 +41,7 @@ The Proxeus software is a powerful workflow engine with blockchain capabilities
 -   foster innovation and evangelize the project by launching and supporting community initiatives, as well as by creating synergies and partnering with relevant community- driven projects.
 
 RESOURCES
----------
+=========
 
 ### Article 4
 
@@ -60,7 +60,7 @@ The Association's resources are derived from:
 -   The funds shall be used in accordance with the goals of the Association.
 
 MEMBERS
--------
+=======
 
 ### Article 5
 
@@ -79,7 +79,7 @@ Membership terminates:
 -   Upon death / bankruptcy / liquidation of a member. In all cases of termination, the membership fee (if applicable) for the current year remains due. Members who have resigned or who are excluded have no rights to any part of the Association's assets. No financial liability of Members: Only the Association's assets may be used for obligations/commitments contracted in its name. Members have no personal liability whatsoever.
 
 ORGANS
-------
+======
 
 ### Article 6
 
@@ -90,7 +90,7 @@ The Association shall include the following organs:
 -   Executive Board
 
 GENERAL ASSEMBLY
-----------------
+================
 
 ### Article 7
 
@@ -159,7 +159,7 @@ Agenda of Ordinary Meeting: The agenda of the Ordinary Meeting of the General As
 -   Miscellaneous business.
 
 EXECUTIVE BOARD
----------------
+===============
 
 ### Article 13
 
@@ -198,7 +198,7 @@ Legal requirement to elect Auditors: The Auditors have to be elected by the Gene
 Voluntary election of Auditors: The General Assembly may, with a two-thirds majority, request the election of an auditor for a limited audit of the accounting even if the above criteria are not met. Responsibilities of Auditors: The auditor shall check the operating and annual accounts prepared by the Executive Board and present a written and detailed report to the General Assembly.
 
 VARIOUS PROVISIONS
-------------------
+==================
 
 ### Article 17
 

diff --git a/docs/architecture.md b/docs/architecture.md
@@ -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
 

diff --git a/docs/backend.md b/docs/backend.md
@@ -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.
 

diff --git a/docs/external_workflow_nodes.md b/docs/external_workflow_nodes.md
@@ -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,