📝 Document Browser Live Debugger Preview limitations

[watson]

Motivation

Browser Live Debugger is in Preview, but the SDK README doesn't say so or list the limitations that come with it. The named-function limitation sits under prerequisites and repeats details that the Live Debugger build plugin, which owns the namedOnly option, now documents in its own "Limitations during Preview" section. Part of DEBUG-6257.

Summary

 ## Prerequisites
   ### Application instrumentation
-    Named-function details and namedOnly recommendation
   ### Source maps
   ### Content Security Policy
+## Limitations during Preview
+  - Named functions only, one build per page → link to the build plugin's section
+  - Possible breaking changes in the SDK and build plugin during the Preview
 ## Usage

Changes

Add a "Limitations during Preview" section between Prerequisites and Usage. It summarizes the instrumentation limitations in one bullet and links to the build plugin's section for details, so they are documented in one place. It also states that this SDK may get breaking changes during the Preview. "Preview" is the external name of the release stage. Documentation only.

Companion: DataDog/build-plugins#575. Merge it first so the new link to #limitations-during-preview resolves.

Evidence

• Before: The README doesn't mention the Preview, and the named-function paragraph repeats the build plugin's namedOnly documentation.
  After: A short Preview limitations section links to the build plugin for instrumentation details.
• Prettier passes on the changed README, and git diff --check is clean.

Test instructions

Review the section alongside the build plugin's "Limitations during Preview" section in the companion PR. No runtime tests run for this documentation-only change.

Checklist

• Tested locally (documentation formatting and link review)
• Tested on staging (not applicable)
• Added unit tests for this change (not applicable)
• Added e2e/integration tests for this change (not applicable)
• Updated documentation and/or relevant AGENTS.md file

Merge Danger

Door: two-way

Blast Radius: Documentation only; no runtime or configuration changes.

🤖 Generated with Claude Code

[chatgpt-codex-connector]

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review	Status	Commit	Review trigger
📝 Code Review	✅ Completed 2026-10-15T10:16:07.893170Z	246ae19	PR opened
🔒 Security Review	✅ Completed 2026-10-15T10:16:44.250862Z	246ae19	PR opened

ℹ️ 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" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

[cit-pr-commenter-54b7da]

Bundles Sizes Evolution

📦 Bundle Name	Base Size	Local Size	𝚫	𝚫%	Status
Rum Salesforce	N/A	188.06 KiB	N/A	N/A	N/A
Rum	188.04 KiB	188.04 KiB	0 B	0.00%	✅
Rum-salesforce Profiler	N/A	8.35 KiB	N/A	N/A	N/A
Rum Profiler	8.35 KiB	8.35 KiB	0 B	0.00%	✅
Rum-salesforce Recorder	N/A	32.04 KiB	N/A	N/A	N/A
Rum Recorder	32.04 KiB	32.04 KiB	0 B	0.00%	✅
Logs	59.44 KiB	59.44 KiB	0 B	0.00%	✅
Rum Slim	145.83 KiB	145.83 KiB	0 B	0.00%	✅
Worker	22.96 KiB	22.96 KiB	0 B	0.00%	✅
Rum Shopify	N/A	218.48 KiB	N/A	N/A	N/A
Rum-shopify Profiler	N/A	8.35 KiB	N/A	N/A	N/A
Rum-shopify Recorder	N/A	4.85 KiB	N/A	N/A	N/A

[datadog-datadog-us1-prod]

✅ All CI checks and tests passed.

🎉 All green!

🧪 All tests passed
❄️ No new flaky tests detected

🎯 Code Coverage (details)
• Patch Coverage: 100.00%
• Overall Coverage: 77.32% (+0.00%)

_{This comment will be updated automatically if new data arrives.
🔗 Commit SHA: 246ae19 | Docs | View more details | Give us feedback!}

[datadog-datadog-us1-prod]

More details

No actionable documentation defects were identified. The new build-plugin limitations link depends on companion PR #575 merging first; its destination was not independently verified.

Was this helpful? React 👍 or 👎

_{Open Bits AI session}

_{🤖 Bits Code Review · Commit 246ae19}