feat: add warning on typedoc for autogenerated files

[Balastrong]

We might want to add a comment on autogenerated files to avoid manual edits there.

This little change should add the comment right on top of the page, after the frontmatter but before the actual content is generated. I ran it on Form and this is the output:

---
id: useTransform
title: useTransform
---

<!-- DO NOT EDIT: this page is autogenerated from the type comments -->

# Function: useTransform()

... rest of the page

Nothing is shown in the final html page as the comment gets entirely removed.

[pkg-pr-new]

npm i https://pkg.pr.new/@tanstack/config@147

commit: 90e105d

[nx-cloud]

View your CI Pipeline Execution ↗ for commit 90e105d.

Command	Status	Duration	Result
nx affected --targets=test:eslint,test:types,te...	✅ Succeeded	18s	View ↗

---

☁️ Nx Cloud last updated this comment at 2025-01-14 03:26:59 UTC

[Balastrong]

@lachlancollins wanna merge? I don't have write access here :D