docs(vercelai): Align types based on implementation#18752
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
![sentry[bot]](https://avatars.githubusercontent.com/in/12637?s=60&v=4){kind=small}
| <PlatformSection notSupported={['javascript.nextjs']}> | ||
| </PlatformSection> | ||
|
|
||
| <PlatformSection notSupported={['javascript.cloudflare', 'javascript.nextjs']}> |
There was a problem hiding this comment.
Bug: The documentation for recordInputs incorrectly implies support for Deno, breaking the pattern where Deno and Cloudflare have parallel feature support.
Severity: LOW
Suggested Fix
To ensure consistency, add 'javascript.deno' to the notSupported array for the recordInputs section in vercelai.mdx. This will align its documented support with that of Cloudflare, as is done for other options in the file.
Prompt for AI Agent
Review the code at the location below. A potential bug has been identified by an AI
agent. Verify if this is a real issue. If it is, propose a fix; if not, explain why it's
not valid.
Location: docs/platforms/javascript/common/configuration/integrations/vercelai.mdx#L148
Potential issue: The documentation for the Vercel AI integration is inconsistent
regarding feature support for Deno. Throughout the file, `javascript.deno` and
`javascript.cloudflare` are treated as having identical support limitations. However,
for the `recordInputs` option, `javascript.deno` is omitted from the `notSupported` list
at line 148, while `javascript.cloudflare` is included. This incorrectly suggests to
Deno users that this feature is supported, which contradicts the established pattern in
the rest of the document. This will likely lead to user confusion.
Did we get this right? 👍 / 👎 to inform future reviews.
| <PlatformSection notSupported={['javascript.nextjs']}> | ||
| </PlatformSection> | ||
|
|
||
| <PlatformSection notSupported={['javascript.cloudflare', 'javascript.nextjs']}> |
There was a problem hiding this comment.
Bug: Documentation for the Vercel AI integration incorrectly shows Deno users the recordInputs and recordOutputs options, which are not supported for their platform at the integration level.
Severity: MEDIUM
Suggested Fix
Add javascript.deno to the notSupported list on line 148 to hide the section documenting the recordInputs and recordOutputs options. Alternatively, add a Deno-specific section explaining that these options are not supported at the integration level and that experimental_telemetry must be used instead.
Prompt for AI Agent
Review the code at the location below. A potential bug has been identified by an AI
agent. Verify if this is a real issue. If it is, propose a fix; if not, explain why it's
not valid.
Location: docs/platforms/javascript/common/configuration/integrations/vercelai.mdx#L148
Potential issue: The documentation for the Vercel AI integration is inconsistent for the
Deno runtime. The PR correctly groups Deno with Cloudflare for initialization behavior,
which requires `experimental_telemetry` on each function call. However, it fails to
update the options documentation completely. As a result, Deno users are shown
documentation for the `recordInputs` and `recordOutputs` configuration options at the
integration level. These options do not work for Deno in the same way as other
platforms. Unlike the Cloudflare documentation, there is no specific note explaining
this limitation for Deno, which will likely cause developers to implement a
configuration that fails or behaves unexpectedly.
3 participants
DESCRIBE YOUR PR
Clarifying the docs. There were also some code changes needed to fix them: getsentry/sentry-javascript#22343
IS YOUR CHANGE URGENT?
Help us prioritize incoming PRs by letting us know when the change needs to go live.
SLA
Thanks in advance for your help!
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes:
LEGAL BOILERPLATE
Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.
EXTRA RESOURCES