feat(iota, docs): update validator commands docs (#4174)

* feat(iota, docs): update validator commands docs * capitalize IOTA
iotaledger · Nov 21, 2024 · 9fa229d · 9fa229d
1 parent d8f126e
commit 9fa229d
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 8 deletions.
diff --git a/crates/iota/src/validator_commands.rs b/crates/iota/src/validator_commands.rs
@@ -187,7 +187,7 @@ pub enum IotaValidatorCommand {
         #[clap(name = "gas-budget", long)]
         gas_budget: Option<u64>,
     },
-    /// Iota native bridge committee member registration
+    /// IOTA native bridge committee member registration.
     #[clap(name = "register-bridge-committee")]
     RegisterBridgeCommittee {
         /// Path to Bridge Authority Key file.
@@ -207,7 +207,7 @@ pub enum IotaValidatorCommand {
         #[clap(name = "gas-budget", long)]
         gas_budget: Option<u64>,
     },
-    /// Update iota native bridge committee node url
+    /// Update IOTA native bridge committee node url.
     UpdateBridgeCommitteeNodeUrl {
         /// New node url to be registered in the on chain bridge object.
         #[clap(long)]

diff --git a/docs/content/references/cli/cheatsheet.mdx b/docs/content/references/cli/cheatsheet.mdx
@@ -1,8 +1,8 @@
 ---
-title: Iota CLI Cheat Sheet
+title: IOTA CLI Cheat Sheet
 ---
 
-The cheat sheet highlights common Iota CLI commands.
+The cheat sheet highlights common IOTA CLI commands.
 
 :::tip
 
@@ -50,7 +50,7 @@ The cheat sheet highlights common Iota CLI commands.
 		</tr>
 		<tr> 	
       <td class="w-2/3">`iota keytool import INPUT KEY_SCHEME`</td>
-			<td class="w-1/3">Add a new key to Iota CLI Keystore using either the input mnemonic phrase or a Bech32 encoded 33-byte flag || privkey starting with "iotaprivkey"</td>
+			<td class="w-1/3">Add a new key to IOTA CLI Keystore using either the input mnemonic phrase or a Bech32 encoded 33-byte flag || privkey starting with "iotaprivkey"</td>
 		</tr>
 		<tr>
 			<td class="w-2/3">`iota keytool update-alias OLD_ALIAS NEW_ALIAS`</td>
@@ -120,11 +120,11 @@ The cheat sheet highlights common Iota CLI commands.
 		</tr>
 		<tr>
 			<td class="w-2/3">`iota genesis`</td>
-			<td class="w-1/3">Bootstrap and initialize a new Iota network</td>
+			<td class="w-1/3">Bootstrap and initialize a new IOTA network</td>
 		</tr>
 		<tr>
 			<td class="w-2/3">`iota start`</td>
-			<td class="w-1/3">Start the local Iota network</td>
+			<td class="w-1/3">Start the local IOTA network</td>
 		</tr>
 		<tr>
 			<td class="w-2/3">`iota-faucet`</td>

diff --git a/docs/content/references/cli/validator.mdx b/docs/content/references/cli/validator.mdx
@@ -22,15 +22,19 @@ Commands:
   update-metadata                   Update the validator metadata
   update-gas-price                  Update gas price that is used to calculate Reference Gas Price
   report-validator                  Report or un-report a validator as bad or non-performant
-  serialize-payload-pop             Serialize the payload that is used to generate Proof of Possession. This is useful to take the payload offline for an Authority keypair to sign
+  serialize-payload-pop             Serialize the payload that is used to generate Proof of Possession. This is useful to take the payload offline for an Authority protocol keypair to sign
   display-gas-price-update-raw-txn  Print out the serialized data of a transaction that sets the gas price quote for a validator
+  register-bridge-committee         IOTA native bridge committee member registration
+  update-bridge-committee-node-url  Update IOTA native bridge committee node url
+  list                              Get a list of the validators in the network. Use the `display-metadata` command to see the complete data for a validator
   help                              Print this message or the help of the given subcommand(s)
 
 Options:
       --client.config <CONFIG>  Sets the file storing the state of our user accounts (an empty one will be created if missing)
       --json                    Return command outputs in json format
   -y, --yes                     
   -h, --help                    Print help
+  -V, --version                 Print version
 ```
 
 ## Examples