Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add warning on typedoc for autogenerated files #147

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Balastrong
Copy link
Member

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.

Copy link

pkg-pr-new bot commented Aug 23, 2024

commit: 3de2779

pnpm add https://pkg.pr.new/@tanstack/config@147

Open in Stackblitz

Copy link

nx-cloud bot commented Aug 23, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 3de2779. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution


✅ Successfully ran 1 target

Sent with 💌 from NxCloud.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant