Add comments to generated files indicating they were generated

[amikofalvy]

Originally, we had discussed using MDX style comments, but I had done some reading on frontmatter and it wasn't clear if the all frontmatter parsers would support adding a MDX style comment (or anything) above the frontmatter declaration in the mdx file.

{/* This file was auto-generated by Fuma Docs. */ }
---
title: Events
description: Special events hosted by the Museum
full: true
_openapi:
  toc:
  ...

So instead, I opted for YAML style comments within the frontmatter section.

---
# This file was auto-generated by Fuma Docs.
# Do not edit this file directly. Any changes should be made by running the generation command again.
title: Events
description: Special events hosted by the Museum
full: true
_openapi:
  toc:
  ...

One good thing about the YAML style comment is that it is less verbose syntactically and doesn't involve as many special characters required to escape the comment area.

If you disagree with the decision to use YAML style, I can re-implement in the MDX style comment and resubmit the PR.

[changeset-bot]

🦋 Changeset detected

Latest commit: 6f563e3

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
fumadocs-openapi	Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[vercel]

@amikofalvy is attempting to deploy a commit to the Fuma Team on Vercel.

A member of the Team first needs to authorize it.

[fuma-nama]

Can we put it at content body (below the frontmatter)?

[amikofalvy]

I've updated the PR to use the MDX style comment format and positioned it beneath the frontmatter section.

Example indicating positioning follows:

---
title: Events
description: Special events hosted by the Museum
full: true
_openapi:
 toc:
---
{/* This file was auto-generated by Fuma Docs. */ }
 ...

[amikofalvy]

This is required otherwise the example comment gets reformatted (via prettier) as

{/_ This file was auto-generated by Fuma Docs.
Do not edit this file directly. Any changes should be made by running the generation command again. _/}

and it renders with the underscores which is incorrect.

[fuma-nama]

Thanks for contributing!