Skip to content

docs(javascript): Add standalone Eve guide (beta.3+) - #19310

Draft
mydea wants to merge 4 commits into
masterfrom
eve-guide
Draft

docs(javascript): Add standalone Eve guide (beta.3+)#19310
mydea wants to merge 4 commits into
masterfrom
eve-guide

Conversation

@mydea

@mydea mydea commented Sep 9, 2026

Copy link
Copy Markdown
Member

DESCRIBE YOUR PR

Adds a standalone Eve JavaScript guide and lifts the old Eve Agent Tracing page into it. Based on getsentry/sentry-javascript#24228, #24247, and #24254.

  • New guide at /platforms/javascript/guides/eve/ that extends the Node guide (fallbackGuide: javascript.node) with Error Monitoring / Tracing / Profiling onboarding toggles. Documents the @sentry/node SDK-based setup (replacing the old OTLP approach), Sentry.eveConversationHook() for linking session turns into Conversations, and getInstrumentedModuleNames() for orchestrion externalDependencies.
  • Removes the old OTLP-based common/agent-tracing/eve.mdx, redirects the old route to the new guide, and keeps the Eve card in the Node Agent Tracing grid (which now redirects to the guide).
  • Adds javascript.eve to every notSupported and supported list in JS common content wherever javascript.node appears. PlatformSection doesn't resolve a guide's fallbackGuide, so Eve must be enumerated alongside Node in both directions — otherwise browser-only content leaks into the Eve guide and inherited Node sections/pages render empty.
  • Registers the Eve sidebar/dropdown icon (javascript-eve).

Important

Do not merge until these APIs ship in the next @sentry/node beta release. The guide documents Sentry.eveConversationHook() (getsentry/sentry-javascript#24247) and getInstrumentedModuleNames() (getsentry/sentry-javascript#24254), which are not yet in a published beta, and requires @sentry/node 11.0.0-beta.3 or later. Merging before that release would document APIs users can't install.

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.
Select exactly one option. For deadlines, replace YYYY-MM-DD with the due date. You can update this information later by editing the PR description.

  • Urgent deadline (GA date, etc.): YYYY-MM-DD
  • Other deadline: YYYY-MM-DD
  • No deadline: Not urgent, can wait up to 1 week+ (blocked on the next @sentry/node beta release — see above)

SLA

  • Teamwork makes the dream work, so please add a reviewer to your PRs.
  • Please give the docs team up to 1 week to review your PR unless you've supplied a deadline.

Thanks in advance for your help!

PRE-MERGE CHECKLIST

Make sure you've checked the following before merging your changes:

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs (subject matter experts)
  • PR was reviewed and approved by a member of the Sentry docs team

🤖 Generated with Claude Code

https://claude.ai/code/session_01RaYGdTstWVZKU9X4NjtYV1

@vercel

vercel Bot commented Sep 9, 2026

Copy link
Copy Markdown

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

Project Deployment Actions Updated
sentry-docs Ready Ready Preview Sep 10, 2026 7:45am UTC
1 Skipped Deployment
Project Deployment Actions Updated
develop-docs Ignored Ignored Preview Sep 10, 2026 7:45am UTC

Request Review

mydea and others added 4 commits September 10, 2026 09:34
…leNames, exclude eve from browser content

- Make the standalone Eve guide extend the Node guide (fallbackGuide: javascript.node)
  with error-monitoring/tracing/profiling onboarding toggles.
- Use getInstrumentedModuleNames() for orchestrion externalDependencies (getsentry/sentry-javascript#24254).
- Add javascript.eve to every notSupported list in JS common content wherever
  javascript.node is excluded, so browser-only content is hidden from the Eve guide.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01RaYGdTstWVZKU9X4NjtYV1
…ascript.node

PlatformSection doesn't resolve a guide's fallbackGuide, so the Eve guide needs
javascript.eve enumerated wherever javascript.node appears in `supported` lists
too, or inherited Node sections and pages render empty under the Eve guide.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01RaYGdTstWVZKU9X4NjtYV1
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Priority: Normal Docs review has no urgent deadline

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant