config icon indicating copy to clipboard operation
config copied to clipboard

feat: add warning on typedoc for autogenerated files

Open Balastrong opened this issue 1 year ago • 2 comments

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.

Balastrong avatar Aug 23 '24 20:08 Balastrong

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

commit: 90e105d

pkg-pr-new[bot] avatar Aug 23 '24 20:08 pkg-pr-new[bot]

View your CI Pipeline Execution ↗ for commit 90e105da07919670e4d6616267ae5b063975c112.

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

nx-cloud[bot] avatar Aug 23 '24 20:08 nx-cloud[bot]

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

Balastrong avatar Jan 14 '25 08:01 Balastrong