Skip to content

ref(docs): Restructure OpenAI integration documentation #16044

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.

Sign up for GitHub

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

Jump to bottom
Open
priscilawebdev wants to merge 16 commits into
base: master
Choose a base branch
from
Open

ref(docs): Restructure OpenAI integration documentation #16044

priscilawebdev wants to merge 16 commits into from

Conversation

@priscilawebdev
Copy link
Member

@priscilawebdev priscilawebdev commented Jan 16, 2026

  • Separate server-side and browser-side usage sections for clarity
  • Document openAIIntegration for Node.js platforms (auto-enabled by default)
  • Document instrumentOpenAiClient for browser and edge runtimes
  • Add special handling for Cloudflare Workers edge runtime
  • Simplify code examples by omitting import statements
  • Move configuration and supported versions to shared sections
  • Improve platform-specific visibility using PlatformSection components

closes https://linear.app/getsentry/issue/TET-1719/browser-javascript-ai-agent-onboarding

@linear
Copy link

linear bot commented Jan 16, 2026

TET-1719 Browser Javascript AI Agent Onboarding

@vercel
Copy link

vercel bot commented Jan 16, 2026 •
edited
Loading

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

Project Deployment Review Updated (UTC)
sentry-docs Ready Ready Preview, Comment Jan 22, 2026 11:51am
1 Skipped Deployment
Project Deployment Review Updated (UTC)
develop-docs Ignored Ignored Preview Jan 22, 2026 11:51am

Request Review

@priscilawebdev priscilawebdev requested review from a team, RulaKhaled and andreiborza January 16, 2026 08:48
@priscilawebdev priscilawebdev marked this pull request as ready for review January 16, 2026 08:48
@priscilawebdev
Copy link
Member Author

priscilawebdev commented Jan 16, 2026

@RulaKhaled I noticed that we do not have a separate section about Runtime for NextJS + OpenAI. should we add something? https://docs.sentry.io/platforms/javascript/guides/nextjs/configuration/integrations/openai/

@priscilawebdev priscilawebdev marked this pull request as draft January 16, 2026 14:19
@priscilawebdev priscilawebdev marked this pull request as ready for review January 19, 2026 08:34
@RulaKhaled
Copy link
Member

RulaKhaled commented Jan 19, 2026

@RulaKhaled I noticed that we do not have a separate section about Runtime for NextJS + OpenAI. should we add something? https://docs.sentry.io/platforms/javascript/guides/nextjs/configuration/integrations/openai/

We don't need to, all runtimes in Next.js should use the manual instrumentation.

andreiborza
andreiborza reviewed Jan 19, 2026
View reviewed changes
priscilawebdev and others added 3 commits January 20, 2026 08:15
@priscilawebdev @andreiborza
Update docs/platforms/javascript/common/configuration/integrations/op…
bae8eaa 
…enai.mdx

Co-authored-by: Andrei <168741329+andreiborza@users.noreply.github.com>
@priscilawebdev @andreiborza
Update docs/platforms/javascript/common/configuration/integrations/op…
fd864a8 
…enai.mdx

Co-authored-by: Andrei <168741329+andreiborza@users.noreply.github.com>
@priscilawebdev @andreiborza
Update docs/platforms/javascript/common/configuration/integrations/op…
81fe6e6 
…enai.mdx

Co-authored-by: Andrei <168741329+andreiborza@users.noreply.github.com>
andreiborza
andreiborza approved these changes Jan 20, 2026
View reviewed changes
Copy link
Member

@andreiborza andreiborza left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

coolguyzone
coolguyzone approved these changes Jan 20, 2026
View reviewed changes
Copy link
Contributor

@coolguyzone coolguyzone left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! 🫡

priscilawebdev and others added 2 commits January 21, 2026 08:29
@priscilawebdev @coolguyzone
Update docs/platforms/javascript/common/configuration/integrations/op…
b038945 
…enai.mdx

Co-authored-by: Alex Krawiec <alex.krawiec@sentry.io>
@priscilawebdev @coolguyzone
Update docs/platforms/javascript/common/configuration/integrations/op…
3eb7902 
…enai.mdx

Co-authored-by: Alex Krawiec <alex.krawiec@sentry.io>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@inventarSarah inventarSarah inventarSarah left review comments

@sentry sentry[bot] sentry[bot] left review comments

@coolguyzone coolguyzone coolguyzone approved these changes

@andreiborza andreiborza andreiborza approved these changes

@RulaKhaled RulaKhaled Awaiting requested review from RulaKhaled

@shellmayr shellmayr Awaiting requested review from shellmayr

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

7 participants

@priscilawebdev @RulaKhaled @inventarSarah @shellmayr @coolguyzone @andreiborza