docs: add comments attribute to plugins section

[beelarr]

Summary

Adds documentation for the comments option introduced in #3317 to the @hey-api/typescript plugin documentation.

Changes

• Added new "Comments" section to the TypeScript plugin documentation
• Documented the boolean comments option with code examples for both enabled (default) and disabled states
• Included practical use cases for when users might want to disable comments

Related

• Closes Allow choosing JSDoc vs TypeDoc comments (or none) #2714
• Implements documentation for feat: add comments option to all plugins #3317

Preview

Comments

By default, @hey-api/typescript will include comments in the generated code based on descriptions from your OpenAPI specification. If you want to reduce the size of your generated files or prefer cleaner output, you can disable comments.

Options:

Value	Description
true (default)	Include comments from OpenAPI descriptions in generated code
false	Strip comments from generated code

Use cases for disabling comments:

• Reduce the size of generated files
• Build process already strips comments
• Prefer referencing the original OpenAPI specification for documentation

[bolt-new-by-stackblitz]

Run & review this pull request in StackBlitz Codeflow.

[vercel]

@beelarr is attempting to deploy a commit to the Hey API Team on Vercel.

A member of the Team first needs to authorize it.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 1943908

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

[chatgpt-codex-connector]

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: da52e0ea8d

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

• Open a pull request for review
• Mark a draft as ready
• Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
hey-api-docs	Ready	Preview, Comment	Feb 6, 2026 5:23pm