Merge pull request #701 from ava-labs/updateDocFixes

Updated docs to match docs site

cmd/subnetcmd/import_from_api.go

@@ -36,13 +36,11 @@ func newImportFromNetworkCmd() *cobra.Command {
 		RunE:         importRunningSubnet,
 		SilenceUsage: true,
 		Args:         cobra.MaximumNArgs(1),
-		Long: `The subnet import public command will import a subnet configuration from a running network.
+		Long: `The subnet import public command imports a Subnet configuration from a running network.
 
-Currently this only supports importing one single chain from a subnet. 
-Therefore, this import asks the blockchain ID from the user.
-The genesis file should be available from the disk for this to work. 
-By default, an imported subnet will not overwrite an existing subnet with the same name. 
-To allow overwrites, provide the --force flag.`,
+The genesis file should be available from the disk for this to work. By default, an imported Subnet
+doesn't overwrite an existing Subnet with the same name. To allow overwrites, provide the --force
+flag.`,
 	}
 
 	cmd.Flags().StringVar(&nodeURL, "node-url", "", "[optional] URL of an already running subnet validator")

cmd/subnetcmd/list.go

@@ -24,9 +24,11 @@ var deployed bool
 // avalanche subnet list
 func newListCmd() *cobra.Command {
 	cmd := &cobra.Command{
-		Use:          "list",
-		Short:        "List all created Subnet configurations",
-		Long:         `The Subnet list command prints the names of all created Subnet configurations.`,
+		Use:   "list",
+		Short: "List all created Subnet configurations",
+		Long: `The subnet list command prints the names of all created Subnet configurations. Without any flags,
+it prints some general, static information about the Subnet. With the --deployed flag, the command
+shows additional information including the VMID, BlockchainID and SubnetID.`,
 		RunE:         listSubnets,
 		SilenceUsage: true,
 	}

cmd/subnetcmd/upgradecmd/apply.go

@@ -59,15 +59,15 @@ func newUpgradeApplyCmd() *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "apply [subnetName]",
 		Short: "Apply upgrade bytes onto subnet nodes",
-		Long: `Apply generated upgrade bytes to running subnet nodes to trigger a network upgrade. 
+		Long: `Apply generated upgrade bytes to running Subnet nodes to trigger a network upgrade.
 
-For public networks (fuji testnet or mainnet), to complete this process, 
+For public networks (Fuji Testnet or Mainnet), to complete this process,
 you must have access to the machine running your validator.
 If the CLI is running on the same machine as your validator, it can manipulate your node's
 configuration automatically. Alternatively, the command can print the necessary instructions
 to upgrade your node manually.
 
-After you update your validator's configuration, you need to restart your validator manually. 
+After you update your validator's configuration, you need to restart your validator manually.
 If you provide the --avalanchego-chain-config-dir flag, this command attempts to write the upgrade file at that path.
 Refer to https://docs.avax.network/nodes/maintain/chain-config-flags#subnet-chain-configs for related documentation.`,
 		RunE: applyCmd,

cmd/subnetcmd/upgradecmd/generate.go

@@ -50,8 +50,8 @@ func newUpgradeGenerateCmd() *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "generate [subnetName]",
 		Short: "Generate the configuration file to upgrade subnet nodes",
-		Long: `Upgrades to subnet nodes can be executed by providing a upgrade.json file to the nodes.
-This command starts a wizard guiding the user generating the required file.`,
+		Long: `The subnet upgrade generate command builds a new upgrade.json file to customize your Subnet. It
+guides the user through the process using an interactive wizard.`,
 		RunE: upgradeGenerateCmd,
 		Args: cobra.ExactArgs(1),
 	}

cmd/subnetcmd/upgradecmd/upgrade.go

@@ -15,9 +15,9 @@ var app *application.Avalanche
 func NewCmd(injectedApp *application.Avalanche) *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "upgrade",
-		Short: "Upgrade your subnets",
+		Short: "Upgrade your Subnets",
 		Long: `The subnet upgrade command suite provides a collection of tools for
-updating your developmental and deployed subnets.`,
+updating your developmental and deployed Subnets.`,
 		Run: func(cmd *cobra.Command, args []string) {
 			err := cmd.Help()
 			if err != nil {

cmd/subnetcmd/upgradecmd/vm.go

@@ -41,9 +41,13 @@ var (
 // avalanche subnet update vm
 func newUpgradeVMCmd() *cobra.Command {
 	cmd := &cobra.Command{
-		Use:          "vm [subnetName]",
-		Short:        "Upgrade a subnet's binary",
-		Long:         "",
+		Use:   "vm [subnetName]",
+		Short: "Upgrade a subnet's binary",
+		Long: `The subnet upgrade vm command enables the user to upgrade their Subnet's VM binary. The command
+can upgrade both local Subnets and publicly deployed Subnets on Fuji and Mainnet.
+
+The command walks the user through an interactive wizard. The user can skip the wizard by providing
+command line flags.`,
 		RunE:         upgradeVM,
 		Args:         cobra.ExactArgs(1),
 		SilenceUsage: true,

cmd/subnetcmd/vmid.go

@@ -15,7 +15,7 @@ func vmidCmd() *cobra.Command {
 	cmd := &cobra.Command{
 		Use:          "vmid [vmName]",
 		Short:        "Prints the VMID of a VM",
-		Long:         `Derives a VMID from the VM's name and prints the VMID`,
+		Long:         `The subnet vmid command prints the virtual machine ID (VMID) for the given Subnet.`,
 		SilenceUsage: true,
 		Args:         cobra.ExactArgs(1),
 		RunE:         printVMID,