fix: fix generation of cli-reference after improving command descriptions (#9995)

davidfirst · web-flow · commit 3b7dcee8cac0 · 2025-09-10T12:46:27.000-04:00
diff --git a/scopes/compilation/compiler/compiler.cmd.ts b/scopes/compilation/compiler/compiler.cmd.ts
@@ -11,7 +11,7 @@ export class CompileCmd implements Command {
   name = 'compile [component-names...]';
   description = 'transpile component source files';
   extendedDescription = `compiles TypeScript, JSX, and other source files into JavaScript using the compiler configured by each component's environment.
-outputs compiled files to node_modules/<component-package-name>/dist for consumption by other components.
+outputs compiled files to node_modules/component-package-name/dist for consumption by other components.
 automatically triggered by "bit watch", "bit start", or IDE extensions, but can be run manually for debugging.`;
   helpUrl = 'reference/compiling/compiler-overview';
   arguments = [
diff --git a/scopes/component/checkout/checkout-cmd.ts b/scopes/component/checkout/checkout-cmd.ts
@@ -33,7 +33,7 @@ export class CheckoutCmd implements Command {
   helpUrl = 'reference/components/merging-changes#checkout-snaps-to-the-working-directory';
   group = 'version-control';
   extendedDescription = `checkout components to specified versions or remove local changes. most commonly used as 'bit checkout head' to get latest versions.
-the <to> argument accepts these values:
+the \`<to>\` argument accepts these values:
 - head: checkout to last snap/tag (most common usage)
 - specific version: checkout to exact version (e.g. 'bit checkout 1.0.5 component-name')
 - head~x: go back x generations from head (e.g. 'head~2' for two versions back)
diff --git a/scopes/component/component/show/show.cmd.ts b/scopes/component/component/show/show.cmd.ts
@@ -14,7 +14,7 @@ export class ShowCmd implements Command {
   name = 'show <component-name>';
   description = 'display component metadata, dependencies, and configuration';
   extendedDescription = `shows detailed information about a component including its version, dependencies, environment, and other metadata.
-note: to see file changes made in a specific version, use "bit diff <component> <version> --parent".`;
+note: to see file changes made in a specific version, use \`bit diff <component> <version> --parent\`.`;
   alias = '';
   group = 'info-analysis';
   arguments = [{ name: 'component-name', description: 'component name or component id' }];
diff --git a/scopes/harmony/cli-reference/cli-reference.docs.mdx b/scopes/harmony/cli-reference/cli-reference.docs.mdx
@@ -1,4 +1,4 @@
 ---
-description: 'Bit command synopses. Bit version: 1.12.120'
+description: 'Bit command synopses. Bit version: 1.12.121'
 labels: ['cli', 'mdx', 'docs']
 ---
diff --git a/scopes/harmony/cli-reference/cli-reference.json b/scopes/harmony/cli-reference/cli-reference.json
diff --git a/scopes/harmony/cli-reference/cli-reference.mdx b/scopes/harmony/cli-reference/cli-reference.mdx
diff --git a/scopes/harmony/cli/help.cmd.ts b/scopes/harmony/cli/help.cmd.ts
@@ -6,7 +6,7 @@ export class HelpCmd implements Command {
   name = 'help';
   description = 'display available commands and usage information';
   extendedDescription =
-    'shows a categorized list of all available Bit commands with brief descriptions. use "bit <command> --help" for detailed help on specific commands.';
+    'shows a categorized list of all available Bit commands with brief descriptions. use `bit <command> --help` for detailed help on specific commands.';
   alias = '$0'; // default command (meaning, if no args are provided, this will be used), see https://github.com/yargs/yargs/blob/master/docs/advanced.md#default-commands
   loader = false;
   group = 'system';
