style(docs): add explainers to TypeDoc tsconfig

freshgum-bubbles · freshgum-bubbles · commit 4afc2cfcc090 · 2023-10-09T15:54:19.000+01:00
diff --git a/tsconfig.typedoc.json b/tsconfig.typedoc.json
@@ -1,5 +1,10 @@
 {
+    // This Typescript configuration is used by TypeDoc to generate API documentation
+    // for the project; this documentation can be accessed via the following link:
+    // <https://typedi.js.org/api-reference>
     "extends": "./tsconfig.json",
     "include": ["./src/**/*"],
+
+    // Elide any non-src folders to prevent them being added to the documentation.
     "exclude": ["./website/**/*", "./website/*", "./test/*", "./docs/*", "./build/*"]
 }

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,10 @@`
`1`	`1`	`{`
	`2`	`+ // This Typescript configuration is used by TypeDoc to generate API documentation`
	`3`	`+ // for the project; this documentation can be accessed via the following link:`
	`4`	`+ // <https://typedi.js.org/api-reference>`
`2`	`5`	`"extends": "./tsconfig.json",`
`3`	`6`	`"include": ["./src/*/"],`
	`7`	`+`
	`8`	`+ // Elide any non-src folders to prevent them being added to the documentation.`
`4`	`9`	`"exclude": ["./website/*/", "./website/", "./test/", "./docs/", "./build/"]`
`5`	`10`	`}`