Merge pull request #81 from ReforgeHQ/mfaga-doc-improvements

mjfaga · web-flow · commit a96509374c9b · 2025-11-24T19:05:15.000-05:00
docs: clarify config file name in example
diff --git a/README.md b/README.md
@@ -150,7 +150,7 @@ GLOBAL FLAGS
 DESCRIPTION
   Generate type definitions for your Reforge configuration
 
-  You can use the default type-generation configuration, or by provide your own:
+  You can use the default type-generation configuration, or by provide your own via a reforge.config.json file:
 
   Format:
   {
@@ -163,7 +163,7 @@ DESCRIPTION
   ​  }
   };
 
-  Example:
+  Example reforge.config.json:
   ```json
   {
   ​  "outputDirectory": "path/to/your/directory",
diff --git a/src/commands/generate.ts b/src/commands/generate.ts
@@ -82,7 +82,7 @@ const DEFAULT_CONFIG: {
 
 export default class Generate extends APICommand {
   /* eslint-disable no-irregular-whitespace */
-  static description = `You can use the default type-generation configuration, or by provide your own:
+  static description = `You can use the default type-generation configuration, or by provide your own via a reforge.config.json file:
 
 Format:
 {
@@ -95,7 +95,7 @@ Format:
 ​  }
 };
 
-Example:
+Example reforge.config.json:
 \`\`\`json
 {
 ​  "outputDirectory": "path/to/your/directory",

Original file line number	Diff line number	Diff line change
`@@ -150,7 +150,7 @@ GLOBAL FLAGS`
`150`	`150`	`DESCRIPTION`
`151`	`151`	`Generate type definitions for your Reforge configuration`
`152`	`152`
`153`		`- You can use the default type-generation configuration, or by provide your own:`
	`153`	`+ You can use the default type-generation configuration, or by provide your own via a reforge.config.json file:`
`154`	`154`
`155`	`155`	`Format:`
`156`	`156`	`{`
`@@ -163,7 +163,7 @@ DESCRIPTION`
`163`	`163`	`}`
`164`	`164`	`};`
`165`	`165`
`166`		`- Example:`
	`166`	`+ Example reforge.config.json:`
`167`	`167`	```json
`168`	`168`	`{`
`169`	`169`	`"outputDirectory": "path/to/your/directory",`
Original file line number	Diff line number	Diff line change
`@@ -82,7 +82,7 @@ const DEFAULT_CONFIG: {`
`82`	`82`
`83`	`83`	`export default class Generate extends APICommand {`
`84`	`84`	`/* eslint-disable no-irregular-whitespace */`
`85`		- static description = `You can use the default type-generation configuration, or by provide your own:
	`85`	+ static description = `You can use the default type-generation configuration, or by provide your own via a reforge.config.json file:
`86`	`86`
`87`	`87`	`Format:`
`88`	`88`	`{`
`@@ -95,7 +95,7 @@ Format:`
`95`	`95`	`}`
`96`	`96`	`};`
`97`	`97`
`98`		`-Example:`
	`98`	`+Example reforge.config.json:`
`99`	`99`	\`\`\`json
`100`	`100`	`{`
`101`	`101`	`"outputDirectory": "path/to/your/directory",`