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

Co-authored-by: Lachlan Collins <1667261+lachlancollins@users.noreply.github.com>
TanStack · Jan 14, 2025 · fe06d12 · fe06d12
1 parent ccc7c2b
commit fe06d12
Showing 1 changed file with 2 additions and 0 deletions.
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