Add documentations

QubitPi · Oct 23, 2023 · 8f5ba07 · 8f5ba07
1 parent a66f0c8
commit 8f5ba07
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 1 deletion.
diff --git a/.github/workflows/release-doc.yml b/.github/workflows/release-doc.yml
@@ -4,6 +4,7 @@
 name: Release
 
 "on":
+  pull_request:
   push:
     branches:
       - master

diff --git a/docs/modules/ROOT/images/modifying-node-properties-example.png b/docs/modules/ROOT/images/modifying-node-properties-example.png
diff --git a/docs/modules/ROOT/pages/operations/index.adoc b/docs/modules/ROOT/pages/operations/index.adoc
@@ -17,4 +17,4 @@
 * xref:operations/rest-requests.adoc[] -- HTTP REST commands.
 * xref:operations/browser-rbac-count.adoc[] -- Manual refresh of counts due to RBAC.
 * xref:operations/product-analytics.adoc[] -- Configure consent for anonymous usage statistics.
-
+* xref:operations/on-canvas-operations.adoc[] -- On-Canvas Operations.
diff --git a/docs/modules/ROOT/pages/operations/on-canvas-operations.adoc b/docs/modules/ROOT/pages/operations/on-canvas-operations.adoc
@@ -0,0 +1,20 @@
+:description: On-Canvas Operations
+
+
+[[on-canvas-operations]]
+= On-Canvas Operations
+
+== Double-Clicking the Canvas
+
+*Double clicking the white area* on canvas will automatically generate a new node with
+
+1. an auto-incremented ID, i.e. (the max ID of nodes on canvas) + 1
+2. a label of "Undefined"
+3. the node caption of "New Node"
+
+== Editing the Node Properties in Inspector Panel
+
+*Clicking the property value* in node inspector panel will make that property editable and un-clicking the text box
+(by for example clicking somewhere else) will persist the new value into Neo4J database:
+
+image:modifying-node-properties-example.png[width=600]
-Original file line number
+Diff line change
@@ Expand Up / @@ -4,6 +4,7 @@ @@
     name: Release
     "on":
+      pull_request:
       push:
         branches:
           - master
@@ Expand Down @@