docs(nxdev): make sure rendered command string includes param indicat…

…ion (#9489)

docs/generated/cli/list.md

@@ -10,7 +10,7 @@ Lists installed plugins, capabilities of installed plugins and other available p
 ## Usage
 
 ```bash
-nx list
+nx list [plugin]
 ```
 
 [Install `nx` globally](/getting-started/nx-setup#install-nx) to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpx nx`.

docs/generated/cli/migrate.md

@@ -16,7 +16,7 @@ Creates a migrations file or runs migrations from the migrations file.
 ## Usage
 
 ```bash
-nx migrate
+nx migrate [packageAndVersion]
 ```
 
 [Install `nx` globally](/getting-started/nx-setup#install-nx) to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpx nx`.

docs/generated/cli/workspace-generator.md

@@ -10,7 +10,7 @@ Runs a workspace generator from the tools/generators directory
 ## Usage
 
 ```bash
-nx workspace-generator
+nx workspace-generator [name]
 ```
 
 [Install `nx` globally](/getting-started/nx-setup#install-nx) to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpx nx`.

docs/generated/cli/workspace-lint.md

@@ -10,7 +10,7 @@ Lint nx specific workspace files (nx.json, workspace.json)
 ## Usage
 
 ```bash
-nx workspace-lint
+nx workspace-lint [files..]
 ```
 
 [Install `nx` globally](/getting-started/nx-setup#install-nx) to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpx nx`.

scripts/documentation/generate-cli-data.ts

@@ -33,6 +33,7 @@ interface ParsedCommandOption {
 
 interface ParsedCommand {
   name: string;
+  commandString: string;
   description: string;
   options?: Array<ParsedCommandOption>;
 }
@@ -80,7 +81,11 @@ export async function generateCLIDocumentation() {
         command.builder.apply
       )
     ) {
-      return { name, description: command.description };
+      return {
+        name,
+        commandString: command.original,
+        description: command.description,
+      };
     }
     // Show all the options we can get from yargs
     const builder = await command.builder(
@@ -92,6 +97,7 @@ export async function generateCLIDocumentation() {
     return {
       name,
       description: command.description,
+      commandString: command.original,
       options:
         Object.keys(builderDescriptions).map((key) => ({
           name: key,
@@ -117,7 +123,7 @@ ${command.description}
 ## Usage
 
 \`\`\`bash
-nx ${command.name}
+nx ${command.commandString}
 \`\`\`
 
 [Install \`nx\` globally](/getting-started/nx-setup#install-nx) to invoke the command directly using \`nx\`, or use \`npx nx\`, \`yarn nx\`, or \`pnpx nx\`.\n`;