Merge pull request #495 from okp4/build/command-docs-mdx3

Build/command docs mdx3
axone-protocol · Jan 3, 2024 · 77c7467 · 77c7467
2 parents 333e784 + 69351f2
commit 77c7467
Show file tree

Hide file tree

Showing 239 changed files with 424 additions and 312 deletions.
diff --git a/Makefile b/Makefile
@@ -390,8 +390,9 @@ doc-command: ## Generate markdown documentation for the command
 	sed -i $(SED_FLAG) 's/(default \"\/.*\/\.okp4d\")/(default \"\/home\/john\/\.okp4d\")/g' $$OUT_FOLDER/*.md; \
 	sed -i $(SED_FLAG) 's/node\ name\ (default\ \".*\")/node\ name\ (default\ \"my-machine\")/g' $$OUT_FOLDER/*.md; \
 	sed -i $(SED_FLAG) 's/IP\ (default\ \".*\")/IP\ (default\ \"127.0.0.1\")/g' $$OUT_FOLDER/*.md; \
+	sed -i $(SED_FLAG) 's/&lt;appd&gt;/okp4d/g' $$OUT_FOLDER/*.md; \
 	sed -i $(SED_FLAG) 's/<appd>/okp4d/g' $$OUT_FOLDER/*.md; \
-    sed -i $(SED_FLAG) 's/<\([a-zA-Z-]*\)>/\&lt;\1\&gt;/g' $$OUT_FOLDER/*.md; \
+	sed -i $(SED_FLAG) -E 's| (https?://[a-zA-Z0-9\.\/_=%-]+)| [\1](\1) |g' $$OUT_FOLDER/*.md; \
 	docker run --rm \
 	  -v `pwd`:/usr/src/docs \
 	  -w /usr/src/docs \

diff --git a/docs/.markdownlint.yaml b/docs/.markdownlint.yaml
@@ -5,3 +5,4 @@ no-inline-html: false
 fenced-code-language: false
 code-block-style: false
 link-fragments: false
+commands-show-output: false
diff --git a/docs/command/okp4d.md b/docs/command/okp4d.md
@@ -7,7 +7,7 @@ OKP4 Daemon 👹
 OKP4 Daemon 👹 - a revolutionary public PoS layer 1 specifically designed to enable communities to trustlessly share data,
 algorithms and resources to build the Dataverse!
 
-Want to lean more about OKP4 network? Complete documentation is available at <https://docs.okp4.network> 👀
+Want to lean more about OKP4 network? Complete documentation is available at [https://docs.okp4.network](https://docs.okp4.network)  👀
 
 ### Options
 

diff --git a/docs/command/okp4d_add-genesis-account.md b/docs/command/okp4d_add-genesis-account.md
@@ -22,7 +22,7 @@ okp4d add-genesis-account [address_or_key_name] [coin][,[coin]] [flags]
   -h, --help                     help for add-genesis-account
       --home string              The application home directory (default "/home/john/.okp4d")
       --keyring-backend string   Select keyring's backend (os|file|kwallet|pass|test) (default "test")
-      --node string              &lt;host&gt;:&lt;port&gt; to Tendermint RPC interface for this chain (default "tcp://localhost:26657")
+      --node string              <host>:<port> to Tendermint RPC interface for this chain (default "tcp://localhost:26657")
   -o, --output string            Output format (text|json) (default "text")
       --vesting-amount string    amount of coins for vesting accounts
       --vesting-cliff-time int   schedule cliff time (unix epoch) for vesting accounts

diff --git a/docs/command/okp4d_config.md b/docs/command/okp4d_config.md
@@ -3,7 +3,7 @@
 Create or query an application CLI configuration file
 
 ```
-okp4d config &lt;key&gt; [value] [flags]
+okp4d config <key> [value] [flags]
 ```
 
 ### Options

diff --git a/docs/command/okp4d_debug_prefixes.md b/docs/command/okp4d_debug_prefixes.md
@@ -13,7 +13,7 @@ okp4d debug prefixes [flags]
 ### Examples
 
 ```
-okp4d debug prefixes
+$ okp4d debug prefixes
 ```
 
 ### Options

diff --git a/docs/command/okp4d_debug_pubkey.md b/docs/command/okp4d_debug_pubkey.md
@@ -7,7 +7,7 @@ Decode a pubkey from proto JSON
 Decode a pubkey from proto JSON and display it's address.
 
 Example:
-$ okp4d debug pubkey '{"@type":"/cosmos.crypto.secp256k1.PubKey","key":"AurroA7jvfPd1AadmmOvWM2rJSwipXfRf8yD6pLbA2DJ"}'
+$ okp4d debug pubkey '\{"@type":"/cosmos.crypto.secp256k1.PubKey","key":"AurroA7jvfPd1AadmmOvWM2rJSwipXfRf8yD6pLbA2DJ"\}'
 
 ```
 okp4d debug pubkey [pubkey] [flags]

diff --git a/docs/command/okp4d_gentx.md b/docs/command/okp4d_gentx.md
@@ -59,7 +59,7 @@ okp4d gentx [key_name] [amount] [flags]
       --ledger                              Use a connected Ledger device
       --min-self-delegation string          The minimum self delegation required on the validator
       --moniker string                      The validator's (optional) moniker
-      --node string                         &lt;host&gt;:&lt;port&gt; to tendermint rpc interface for this chain (default "tcp://localhost:26657")
+      --node string                         <host>:<port> to tendermint rpc interface for this chain (default "tcp://localhost:26657")
       --node-id string                      The node's NodeID
       --note string                         Note to add a description to the transaction (previously --memo)
       --offline                             Offline mode (does not allow any online functionality)

diff --git a/docs/command/okp4d_keys.md b/docs/command/okp4d_keys.md
@@ -21,10 +21,10 @@ The keyring supports the following backends:
 
 kwallet and pass backends depend on external tools. Refer to their respective documentation for more
 information:
-    KWallet     <https://github.com/KDE/kwallet>
-    pass        <https://www.passwordstore.org/>
+    KWallet     [https://github.com/KDE/kwallet](https://github.com/KDE/kwallet)
+    pass        [https://www.passwordstore.org/](https://www.passwordstore.org/)
 
-The pass backend requires GnuPG: <https://gnupg.org/>
+The pass backend requires GnuPG: [https://gnupg.org/](https://gnupg.org/)
 
 ### Options
 

diff --git a/docs/command/okp4d_keys_add.md b/docs/command/okp4d_keys_add.md
@@ -24,7 +24,7 @@ Example:
     keys add mymultisig --multisig "keyname1,keyname2,keyname3" --multisig-threshold 2
 
 ```
-okp4d keys add &lt;name&gt; [flags]
+okp4d keys add <name> [flags]
 ```
 
 ### Options
@@ -43,7 +43,7 @@ okp4d keys add &lt;name&gt; [flags]
       --multisig-threshold int   K out of N required signatures. For use in conjunction with --multisig (default 1)
       --no-backup                Don't print out seed phrase (if others are watching the terminal)
       --nosort                   Keys passed to --multisig are taken in the order they're supplied
-      --pubkey string            Parse a public key in JSON format and saves key info to &lt;name&gt; file.
+      --pubkey string            Parse a public key in JSON format and saves key info to <name> file.
       --recover                  Provide seed phrase to recover existing key instead of creating
 ```
 

diff --git a/docs/command/okp4d_keys_delete.md b/docs/command/okp4d_keys_delete.md
@@ -11,7 +11,7 @@ only the public key references stored locally, i.e.
 private keys stored in a ledger device cannot be deleted with the CLI.
 
 ```
-okp4d keys delete &lt;name&gt;... [flags]
+okp4d keys delete <name>... [flags]
 ```
 
 ### Options

diff --git a/docs/command/okp4d_keys_export.md b/docs/command/okp4d_keys_export.md
@@ -14,7 +14,7 @@ FULLY AWARE OF THE RISKS. If you are unsure, you may want to do some research
 and export your keys in ASCII-armored encrypted format.
 
 ```
-okp4d keys export &lt;name&gt; [flags]
+okp4d keys export <name> [flags]
 ```
 
 ### Options

diff --git a/docs/command/okp4d_keys_import.md b/docs/command/okp4d_keys_import.md
@@ -7,7 +7,7 @@ Import private keys into the local keybase
 Import a ASCII armored private key into the local keybase.
 
 ```
-okp4d keys import &lt;name&gt; &lt;keyfile&gt; [flags]
+okp4d keys import <name> <keyfile> [flags]
 ```
 
 ### Options

diff --git a/docs/command/okp4d_keys_migrate.md b/docs/command/okp4d_keys_migrate.md
@@ -10,7 +10,7 @@ If this is the case, the key is already migrated. Therefore, we skip it and cont
 Otherwise, we try to deserialize it using Amino into LegacyInfo. If this attempt is successful, we serialize
 LegacyInfo to Protobuf serialization format and overwrite the keyring entry. If any error occurred, it will be
 outputted in CLI and migration will be continued until all keys in the keyring DB are exhausted.
-See <https://github.com/cosmos/cosmos-sdk/pull/9695> for more details.
+See [https://github.com/cosmos/cosmos-sdk/pull/9695](https://github.com/cosmos/cosmos-sdk/pull/9695)  for more details.
 
 It is recommended to run in 'dry-run' mode first to verify all key migration material.
 

diff --git a/docs/command/okp4d_query_account.md b/docs/command/okp4d_query_account.md
@@ -13,7 +13,7 @@ okp4d query account [address] [flags]
       --grpc-insecure      allow gRPC over insecure channels, if not TLS the server must use TLS
       --height int         Use a specific height to query state at (this can error if the node is pruning state)
   -h, --help               help for account
-      --node string        &lt;host&gt;:&lt;port&gt; to Tendermint RPC interface for this chain (default "tcp://localhost:26657")
+      --node string        <host>:<port> to Tendermint RPC interface for this chain (default "tcp://localhost:26657")
   -o, --output string      Output format (text|json) (default "text")
 ```
 

diff --git a/docs/command/okp4d_query_auth_account.md b/docs/command/okp4d_query_auth_account.md
@@ -13,7 +13,7 @@ okp4d query auth account [address] [flags]
       --grpc-insecure      allow gRPC over insecure channels, if not TLS the server must use TLS
       --height int         Use a specific height to query state at (this can error if the node is pruning state)
   -h, --help               help for account
-      --node string        &lt;host&gt;:&lt;port&gt; to Tendermint RPC interface for this chain (default "tcp://localhost:26657")
+      --node string        <host>:<port> to Tendermint RPC interface for this chain (default "tcp://localhost:26657")
   -o, --output string      Output format (text|json) (default "text")
 ```
 

diff --git a/docs/command/okp4d_query_auth_accounts.md b/docs/command/okp4d_query_auth_accounts.md
@@ -15,7 +15,7 @@ okp4d query auth accounts [flags]
       --height int         Use a specific height to query state at (this can error if the node is pruning state)
   -h, --help               help for accounts
       --limit uint         pagination limit of all-accounts to query for (default 100)
-      --node string        &lt;host&gt;:&lt;port&gt; to Tendermint RPC interface for this chain (default "tcp://localhost:26657")
+      --node string        <host>:<port> to Tendermint RPC interface for this chain (default "tcp://localhost:26657")
       --offset uint        pagination offset of all-accounts to query for
   -o, --output string      Output format (text|json) (default "text")
       --page uint          pagination page of all-accounts to query for. This sets offset to a multiple of limit (default 1)

diff --git a/docs/command/okp4d_query_auth_address-by-acc-num.md b/docs/command/okp4d_query_auth_address-by-acc-num.md
@@ -19,7 +19,7 @@ okp4d q auth address-by-acc-num 1
       --grpc-insecure      allow gRPC over insecure channels, if not TLS the server must use TLS
       --height int         Use a specific height to query state at (this can error if the node is pruning state)
   -h, --help               help for address-by-acc-num
-      --node string        &lt;host&gt;:&lt;port&gt; to Tendermint RPC interface for this chain (default "tcp://localhost:26657")
+      --node string        <host>:<port> to Tendermint RPC interface for this chain (default "tcp://localhost:26657")
   -o, --output string      Output format (text|json) (default "text")
 ```
 

diff --git a/docs/command/okp4d_query_auth_module-account.md b/docs/command/okp4d_query_auth_module-account.md
@@ -19,7 +19,7 @@ okp4d q auth module-account auth
       --grpc-insecure      allow gRPC over insecure channels, if not TLS the server must use TLS
       --height int         Use a specific height to query state at (this can error if the node is pruning state)
   -h, --help               help for module-account
-      --node string        &lt;host&gt;:&lt;port&gt; to Tendermint RPC interface for this chain (default "tcp://localhost:26657")
+      --node string        <host>:<port> to Tendermint RPC interface for this chain (default "tcp://localhost:26657")
   -o, --output string      Output format (text|json) (default "text")
 ```
 

diff --git a/docs/command/okp4d_query_auth_module-accounts.md b/docs/command/okp4d_query_auth_module-accounts.md
@@ -13,7 +13,7 @@ okp4d query auth module-accounts [flags]
       --grpc-insecure      allow gRPC over insecure channels, if not TLS the server must use TLS
       --height int         Use a specific height to query state at (this can error if the node is pruning state)
   -h, --help               help for module-accounts
-      --node string        &lt;host&gt;:&lt;port&gt; to Tendermint RPC interface for this chain (default "tcp://localhost:26657")
+      --node string        <host>:<port> to Tendermint RPC interface for this chain (default "tcp://localhost:26657")
   -o, --output string      Output format (text|json) (default "text")
 ```
 

diff --git a/docs/command/okp4d_query_auth_params.md b/docs/command/okp4d_query_auth_params.md
@@ -19,7 +19,7 @@ okp4d query auth params [flags]
       --grpc-insecure      allow gRPC over insecure channels, if not TLS the server must use TLS
       --height int         Use a specific height to query state at (this can error if the node is pruning state)
   -h, --help               help for params
-      --node string        &lt;host&gt;:&lt;port&gt; to Tendermint RPC interface for this chain (default "tcp://localhost:26657")
+      --node string        <host>:<port> to Tendermint RPC interface for this chain (default "tcp://localhost:26657")
   -o, --output string      Output format (text|json) (default "text")
 ```
 

diff --git a/docs/command/okp4d_query_authz_grants-by-grantee.md b/docs/command/okp4d_query_authz_grants-by-grantee.md
@@ -21,7 +21,7 @@ okp4d query authz grants-by-grantee [grantee-addr] [flags]
       --height int         Use a specific height to query state at (this can error if the node is pruning state)
   -h, --help               help for grants-by-grantee
       --limit uint         pagination limit of grantee-grants to query for (default 100)
-      --node string        &lt;host&gt;:&lt;port&gt; to Tendermint RPC interface for this chain (default "tcp://localhost:26657")
+      --node string        <host>:<port> to Tendermint RPC interface for this chain (default "tcp://localhost:26657")
       --offset uint        pagination offset of grantee-grants to query for
   -o, --output string      Output format (text|json) (default "text")
       --page uint          pagination page of grantee-grants to query for. This sets offset to a multiple of limit (default 1)

diff --git a/docs/command/okp4d_query_authz_grants-by-granter.md b/docs/command/okp4d_query_authz_grants-by-granter.md
@@ -21,7 +21,7 @@ okp4d query authz grants-by-granter [granter-addr] [flags]
       --height int         Use a specific height to query state at (this can error if the node is pruning state)
   -h, --help               help for grants-by-granter
       --limit uint         pagination limit of granter-grants to query for (default 100)
-      --node string        &lt;host&gt;:&lt;port&gt; to Tendermint RPC interface for this chain (default "tcp://localhost:26657")
+      --node string        <host>:<port> to Tendermint RPC interface for this chain (default "tcp://localhost:26657")
       --offset uint        pagination offset of granter-grants to query for
   -o, --output string      Output format (text|json) (default "text")
       --page uint          pagination page of granter-grants to query for. This sets offset to a multiple of limit (default 1)

diff --git a/docs/command/okp4d_query_authz_grants.md b/docs/command/okp4d_query_authz_grants.md
@@ -23,7 +23,7 @@ okp4d query authz grants [granter-addr] [grantee-addr] [msg-type-url]? [flags]
       --height int         Use a specific height to query state at (this can error if the node is pruning state)
   -h, --help               help for grants
       --limit uint         pagination limit of grants to query for (default 100)
-      --node string        &lt;host&gt;:&lt;port&gt; to Tendermint RPC interface for this chain (default "tcp://localhost:26657")
+      --node string        <host>:<port> to Tendermint RPC interface for this chain (default "tcp://localhost:26657")
       --offset uint        pagination offset of grants to query for
   -o, --output string      Output format (text|json) (default "text")
       --page uint          pagination page of grants to query for. This sets offset to a multiple of limit (default 1)

diff --git a/docs/command/okp4d_query_bank_balances.md b/docs/command/okp4d_query_bank_balances.md
@@ -24,7 +24,7 @@ okp4d query bank balances [address] [flags]
       --height int         Use a specific height to query state at (this can error if the node is pruning state)
   -h, --help               help for balances
       --limit uint         pagination limit of all balances to query for (default 100)
-      --node string        &lt;host&gt;:&lt;port&gt; to Tendermint RPC interface for this chain (default "tcp://localhost:26657")
+      --node string        <host>:<port> to Tendermint RPC interface for this chain (default "tcp://localhost:26657")
       --offset uint        pagination offset of all balances to query for
   -o, --output string      Output format (text|json) (default "text")
       --page uint          pagination page of all balances to query for. This sets offset to a multiple of limit (default 1)

diff --git a/docs/command/okp4d_query_bank_denom-metadata.md b/docs/command/okp4d_query_bank_denom-metadata.md
@@ -25,7 +25,7 @@ okp4d query bank denom-metadata [flags]
       --grpc-insecure      allow gRPC over insecure channels, if not TLS the server must use TLS
       --height int         Use a specific height to query state at (this can error if the node is pruning state)
   -h, --help               help for denom-metadata
-      --node string        &lt;host&gt;:&lt;port&gt; to Tendermint RPC interface for this chain (default "tcp://localhost:26657")
+      --node string        <host>:<port> to Tendermint RPC interface for this chain (default "tcp://localhost:26657")
   -o, --output string      Output format (text|json) (default "text")
 ```
 

diff --git a/docs/command/okp4d_query_bank_send-enabled.md b/docs/command/okp4d_query_bank_send-enabled.md
@@ -35,7 +35,7 @@ Getting all entries:
       --height int         Use a specific height to query state at (this can error if the node is pruning state)
   -h, --help               help for send-enabled
       --limit uint         pagination limit of send enabled entries to query for (default 100)
-      --node string        &lt;host&gt;:&lt;port&gt; to Tendermint RPC interface for this chain (default "tcp://localhost:26657")
+      --node string        <host>:<port> to Tendermint RPC interface for this chain (default "tcp://localhost:26657")
       --offset uint        pagination offset of send enabled entries to query for
   -o, --output string      Output format (text|json) (default "text")
       --page uint          pagination page of send enabled entries to query for. This sets offset to a multiple of limit (default 1)

diff --git a/docs/command/okp4d_query_bank_spendable-balances.md b/docs/command/okp4d_query_bank_spendable-balances.md
@@ -9,7 +9,7 @@ okp4d query bank spendable-balances [address] [flags]
 ### Examples
 
 ```
-okp4d query bank spendable-balances [address]
+$ okp4d query bank spendable-balances [address]
 ```
 
 ### Options
@@ -22,7 +22,7 @@ okp4d query bank spendable-balances [address]
       --height int         Use a specific height to query state at (this can error if the node is pruning state)
   -h, --help               help for spendable-balances
       --limit uint         pagination limit of spendable balances to query for (default 100)
-      --node string        &lt;host&gt;:&lt;port&gt; to Tendermint RPC interface for this chain (default "tcp://localhost:26657")
+      --node string        <host>:<port> to Tendermint RPC interface for this chain (default "tcp://localhost:26657")
       --offset uint        pagination offset of spendable balances to query for
   -o, --output string      Output format (text|json) (default "text")
       --page uint          pagination page of spendable balances to query for. This sets offset to a multiple of limit (default 1)

diff --git a/docs/command/okp4d_query_bank_total.md b/docs/command/okp4d_query_bank_total.md
@@ -26,7 +26,7 @@ okp4d query bank total [flags]
       --height int         Use a specific height to query state at (this can error if the node is pruning state)
   -h, --help               help for total
       --limit uint         pagination limit of all supply totals to query for (default 100)
-      --node string        &lt;host&gt;:&lt;port&gt; to Tendermint RPC interface for this chain (default "tcp://localhost:26657")
+      --node string        <host>:<port> to Tendermint RPC interface for this chain (default "tcp://localhost:26657")
       --offset uint        pagination offset of all supply totals to query for
   -o, --output string      Output format (text|json) (default "text")
       --page uint          pagination page of all supply totals to query for. This sets offset to a multiple of limit (default 1)

diff --git a/docs/command/okp4d_query_distribution_commission.md b/docs/command/okp4d_query_distribution_commission.md
@@ -20,7 +20,7 @@ okp4d query distribution commission [validator] [flags]
       --grpc-insecure      allow gRPC over insecure channels, if not TLS the server must use TLS
       --height int         Use a specific height to query state at (this can error if the node is pruning state)
   -h, --help               help for commission
-      --node string        &lt;host&gt;:&lt;port&gt; to Tendermint RPC interface for this chain (default "tcp://localhost:26657")
+      --node string        <host>:<port> to Tendermint RPC interface for this chain (default "tcp://localhost:26657")
   -o, --output string      Output format (text|json) (default "text")
 ```
 

diff --git a/docs/command/okp4d_query_distribution_community-pool.md b/docs/command/okp4d_query_distribution_community-pool.md
@@ -20,7 +20,7 @@ okp4d query distribution community-pool [flags]
       --grpc-insecure      allow gRPC over insecure channels, if not TLS the server must use TLS
       --height int         Use a specific height to query state at (this can error if the node is pruning state)
   -h, --help               help for community-pool
-      --node string        &lt;host&gt;:&lt;port&gt; to Tendermint RPC interface for this chain (default "tcp://localhost:26657")
+      --node string        <host>:<port> to Tendermint RPC interface for this chain (default "tcp://localhost:26657")
   -o, --output string      Output format (text|json) (default "text")
 ```
 

diff --git a/docs/command/okp4d_query_distribution_params.md b/docs/command/okp4d_query_distribution_params.md
@@ -13,7 +13,7 @@ okp4d query distribution params [flags]
       --grpc-insecure      allow gRPC over insecure channels, if not TLS the server must use TLS
       --height int         Use a specific height to query state at (this can error if the node is pruning state)
   -h, --help               help for params
-      --node string        &lt;host&gt;:&lt;port&gt; to Tendermint RPC interface for this chain (default "tcp://localhost:26657")
+      --node string        <host>:<port> to Tendermint RPC interface for this chain (default "tcp://localhost:26657")
   -o, --output string      Output format (text|json) (default "text")
 ```