docs(rust): Update CLI documentation for the status and reset com…

…mands

Signed-off-by: Wryhder <[email protected]>

implementations/rust/ockam/ockam_command/src/reset/mod.rs

@@ -13,8 +13,15 @@ use ockam_node::Context;
 
 use crate::util::async_cmd;
 
+const LONG_ABOUT: &str = include_str!("./static/long_about.txt");
+const AFTER_LONG_HELP: &str = include_str!("./static/after_long_help.txt");
+
 /// Removes the local Ockam configuration including all Identities and Nodes
 #[derive(Clone, Debug, Args)]
+#[command(
+    long_about = docs::about(LONG_ABOUT),
+    after_long_help = docs::after_help(AFTER_LONG_HELP)
+)]
 pub struct ResetCommand {
     /// Confirm the reset without prompting
     #[arg(long, short)]

implementations/rust/ockam/ockam_command/src/reset/static/after_long_help.txt

@@ -0,0 +1,8 @@
+# This will prompt you for confirmation before proceeding
+$ ockam reset
+
+# To confirm without prompting
+$ ockam reset -y
+
+# Remove your spaces from the Orchestrator
+ockam reset --all

implementations/rust/ockam/ockam_command/src/reset/static/long_about.txt

@@ -0,0 +1 @@
+[TBD]

implementations/rust/ockam/ockam_command/src/status/mod.rs

@@ -22,8 +22,15 @@ use ockam_api::nodes::{BackgroundNodeClient, InMemoryNode};
 use ockam_api::output::Output;
 use ockam_api::{fmt_heading, fmt_log, fmt_separator, fmt_warn};
 
+const LONG_ABOUT: &str = include_str!("./static/long_about.txt");
+const AFTER_LONG_HELP: &str = include_str!("./static/after_long_help.txt");
+
 /// Display information about the system's status
 #[derive(Clone, Debug, Args)]
+#[command(
+    long_about = docs::about(LONG_ABOUT),
+    after_long_help = docs::after_help(AFTER_LONG_HELP)
+)]
 pub struct StatusCommand {
     #[command(flatten)]
     timeout: TimeoutArg,

implementations/rust/ockam/ockam_command/src/status/static/after_long_help.txt

@@ -0,0 +1,7 @@
+# To show information about all of the system's Identities and Nodes
+# Includes all identities, whether enrolled or unenrolled
+$ ockam status
+
+# Change the default timeout duration of the status command
+# Defaults to 2s if unspecified 
+$ ockam status --timeout 0.5s 

implementations/rust/ockam/ockam_command/src/status/static/long_about.txt

@@ -0,0 +1,9 @@
+[TBD: Is the following useful information?]
+[TBD: What needs to be elaborated on, and in what way?]
+
+The status command displays the current status of your machine, including information such as:
+- controller and project version [TBD: what are these?]
+- all cryptographic identities stored in your vault, their enrollment status with the Ockam Orchestrator,
+  date of enrollment (if enrolled), and the email address associated with each identity
+- the status of any Nodes, process ids, associated routes and transport protocols, secure channels,
+  portals, and running services