feat: add warning on typedoc for autogenerated files (#147)

Balastrong · lachlancollins · web-flow · commit fe06d12579c9 · 2025-01-14T22:30:35.000+11:00
Co-authored-by: Lachlan Collins &lt;1667261+lachlancollins@users.noreply.github.com&gt;
diff --git a/packages/config/src/typedoc/typedoc-custom-settings.js b/packages/config/src/typedoc/typedoc-custom-settings.js
@@ -16,6 +16,8 @@ export function load(app) {
         id: page.model.name,
         title: page.model.name,
       }
+      page.contents =
+        '<!-- DO NOT EDIT: this page is autogenerated from the type comments -->\n\n'
     },
   )
   // Rename output files

Original file line number	Diff line number	Diff line change
`@@ -16,6 +16,8 @@ export function load(app) {`
`16`	`16`	`id: page.model.name,`
`17`	`17`	`title: page.model.name,`
`18`	`18`	`}`
	`19`	`+ page.contents =`
	`20`	`+ '<!-- DO NOT EDIT: this page is autogenerated from the type comments -->\n\n'`
`19`	`21`	`},`
`20`	`22`	`)`
`21`	`23`	`// Rename output files`