Merge pull request #743 from lmorg/develop

Develop

.github/workflows/deploy-docs.yaml

@@ -47,6 +47,10 @@ jobs:
           ./docgen -panic -warning -config gen/docgen.yaml
           mv -v *.md *.svg docs/
           mv -v gen/vuepress docs/.vuepress
+          
+          for f in $(find docs -type f -regex '.*?/[-_A-Z]+\..*'); do
+            mv -v "$f" "$(echo $f | tr '[A-Z]' '[a-z]')"
+          done
 
       - name: Install pnpm
         uses: pnpm/action-setup@v2

.gitignore

@@ -46,3 +46,9 @@ murex.iml
 
 # Codecov.io
 coverage.txt
+
+# viewpress
+node_modules/
+docs/.vuepress/.temp/
+docs/.vuepress/.cache/
+docs/.vuepress/dist/

builtins/core/arraytools/2darray_doc.yaml

@@ -94,8 +94,8 @@
   - ja
   - jsplit
   - count
-  - index
+  - item-index
   - range
   - mtac
   - msort
-  - types/json
+  - json

builtins/core/arraytools/addheading_doc.yaml

@@ -21,7 +21,7 @@
   Detail:
   Synonyms:
   Related:
-  - index
+  - item-index
   - element
   - cast
   - append

builtins/core/arraytools/map_doc.yaml

@@ -32,5 +32,5 @@
     - jsplit
     - range
     - alter
-    - index
+    - item-index
     - element

builtins/core/autocomplete/autocomplete_doc.yaml

@@ -33,8 +33,8 @@
     - function
     - alias
     - summary
-    - types/mxjson
-    - index
+    - mxjson
+    - item-index
     - get-type
     - switch
     - stdin

builtins/core/config/config_doc.yaml

@@ -198,13 +198,13 @@
   - runtime
   - open
   - event
-  - types/mxjson
+  - mxjson
   - append
   - function
   - match
   - get
   - post
   - getfile
-  - index
+  - item-index
   - element
 

builtins/core/datatools/alter_doc.yaml

@@ -141,7 +141,7 @@
     "-s"     : Alias for `--sum`
   Synonyms:
   Related:
-  - index
+  - item-index
   - element
   - format
   - append

builtins/core/datatools/count_doc.yaml

@@ -113,7 +113,7 @@
     - ja
     - ta
     - jsplit
-    - index
+    - item-index
     - element
     - range
     - mtac

builtins/core/datatools/structkeys_doc.yaml

@@ -142,7 +142,7 @@
   Synonyms:
   Related:
   - set
-  - index
+  - item-index
   - element
   - formap
 

builtins/core/element/element_doc.yaml

@@ -1,7 +1,7 @@
 - DocumentID: element
   Title: >+
-    `[[` (element)
-  CategoryID: commands
+    `[[ element ]]`
+  CategoryID: parser
   Summary: >-
     Outputs an element from a nested structure
   Description: |-
@@ -114,5 +114,5 @@
     - a
     - ja
     - mtac
-    - index
+    - item-index
     - config

builtins/core/escape/escape_doc.yaml

@@ -200,7 +200,7 @@
   Related:
     - alias
     - out
-    - index
+    - item-index
     - escape
     - eschtml
     - escurl

builtins/core/httpclient/get_doc.yaml

@@ -69,7 +69,7 @@
   Synonyms:
   Related:
   - post
-  - index
+  - item-index
   - element
   - getfile
   - config

builtins/core/httpclient/post_doc.yaml

@@ -70,7 +70,7 @@
   Synonyms:
   Related:
   - get
-  - index
+  - item-index
   - element
   - getfile
   - config

builtins/core/index/index_doc.yaml

@@ -1,7 +1,7 @@
 - DocumentID: item-index
   Title: >+
-    `[` (index)
-  CategoryID: commands
+    `[index]`
+  CategoryID: parser
   Summary: >-
     Outputs an element from an array, map or table
   Description: |-
@@ -119,6 +119,7 @@
   Synonyms:
     - "["
     - "!["
+    - item-index
     - index
   Related:
     - range

builtins/core/io/echo_doc.yaml

@@ -35,14 +35,14 @@
   Related:
     - tout
     - err
-    - brace-quote
+    - brace-quote-func
     - cast
     - greater-than
     - greater-than-greater-than
     - pt
     - read
     - tread
-    - user-guide/ansi
+    - ansi
 
 - DocumentID: tout
   Title: >+
@@ -73,18 +73,18 @@
   Related:
     - out
     - err
-    - brace-quote
+    - brace-quote-func
     - cast
     - pretty
     - format
-    - user-guide/ansi
+    - ansi
 
-- DocumentID: brace-quote
+- DocumentID: brace-quote-func
   Title: >+
-    `(` (brace quote)
-  CategoryID: commands
+    `(brace quote)`
+  CategoryID: parser
   Summary: >-
-    Write a string to the STDOUT without new line
+    Write a string to the STDOUT without new line (deprecated)
   Description: |-
     Write parameters to STDOUT (does not include a new line)
   Usage: |-
@@ -126,7 +126,7 @@
     - greater-than
     - greater-than-greater-than
     - pt
-    - user-guide/ansi
+    - ansi
 
 - DocumentID: err
   Title: >+
@@ -177,13 +177,13 @@
   Related:
     - tout
     - out
-    - brace-quote
+    - brace-quote-func
     - cast
     - bg
     - pipe
     - pretty
     - greater-than
     - greater-than-greater-than
     - pt
-    - user-guide/ansi
+    - ansi
     - namedpipe

builtins/core/io/f_doc.yaml

@@ -81,4 +81,4 @@
   Related:
     - g
     - rx
-    - types/json
+    - json

builtins/core/io/file_doc.yaml

@@ -1,7 +1,7 @@
 - DocumentID: greater-than
   Title: >+
-    `>` (truncate file)
-  CategoryID: commands
+    `|>` (truncate file)
+  CategoryID: parser
   Summary: >-
     Writes STDIN to disk - overwriting contents if file already exists
   Description: |-
@@ -26,15 +26,15 @@
     - pipe
     - g
     - tmp
-    - parser/pipe-arrow
-    - parser/pipe-posix
-    - commands/namedpipe
-    - parser/pipe-err
+    - pipe-arrow
+    - pipe-posix
+    - namedpipe
+    - pipe-err
 
 - DocumentID: greater-than-greater-than
   Title: >+
     `>>` (append file)
-  CategoryID: commands
+  CategoryID: parser
   Summary: >-
     Writes STDIN to disk - appending contents if file already exists
   Description: |-
@@ -59,10 +59,10 @@
     - pipe
     - g
     - tmp
-    - parser/pipe-arrow
-    - parser/pipe-posix
-    - commands/namedpipe
-    - parser/pipe-err
+    - pipe-arrow
+    - pipe-posix
+    - namedpipe
+    - pipe-err
 
 - DocumentID: pt
   Title: >+

builtins/core/lists/append_doc.yaml

@@ -38,7 +38,7 @@
     - prepend
     - list.prepend
   Related:
-    - index
+    - item-index
     - element
     - cast
     - append
@@ -86,15 +86,15 @@
     - append
     - list.append
   Related:
-    - index
+    - item-index
     - element
     - cast
     - prepend
     - addheading
     - a
     - ja
     - count
-    - index
+    - item-index
     - range
     - mtac
     - msort

builtins/core/lists/jsplit_doc.yaml

@@ -41,7 +41,7 @@
   - ja
   - 2darray
   - count
-  - index
+  - item-index
   - element
   - range
   - mtac

builtins/core/lists/msort_doc.yaml

@@ -56,5 +56,5 @@
     - range
     - alter
     - mtac
-    - index
+    - item-index
     - element

builtins/core/lists/push_pop_doc.yaml

@@ -54,8 +54,8 @@
     - a
     - count
     - runtime
-    - apis/lang.MarshalData
-    - apis/lang.UnmarshalData
+    - lang.MarshalData
+    - lang.UnmarshalData
 
 - DocumentID: right
   Title: >+
@@ -113,8 +113,8 @@
     - a
     - count
     - runtime
-    - apis/lang.MarshalData
-    - apis/lang.UnmarshalData
+    - lang.MarshalData
+    - lang.UnmarshalData
 
 - DocumentID: prefix
   Title: >+
@@ -156,8 +156,8 @@
     - a
     - count
     - runtime
-    - apis/lang.MarshalData
-    - apis/lang.UnmarshalData
+    - lang.MarshalData
+    - lang.UnmarshalData
 
 - DocumentID: suffix
   Title: >+
@@ -199,5 +199,5 @@
     - a
     - count
     - runtime
-    - apis/lang.MarshalData
-    - apis/lang.UnmarshalData
+    - lang.MarshalData
+    - lang.UnmarshalData

builtins/core/management/functions_doc.yaml

@@ -411,7 +411,7 @@
     ```
   Synonyms:
   Related:
-  - user-guide/reserved-vars
+  - reserved-vars
   - source
 
 
@@ -454,6 +454,6 @@
   Related:
   - runtime
   - fexec
-  - user-guide/modules
+  - modules
 
 

builtins/core/management/shell_doc.yaml

@@ -116,7 +116,7 @@
   Detail:
   Synonyms:
   Related:
-  - user-guide/reserved-vars
+  - reserved-vars