Skip to content

docs: write Node SDK guide for new integrations - #807

Open
roncohen wants to merge 6 commits into
mainfrom
docs/standalone-v2-node-guide
Open

roncohen wants to merge 6 commits into
mainfrom
docs/standalone-v2-node-guide

Conversation

@roncohen

@roncohen roncohen commented Nov 15, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Follow-up to the preview review in reflagcom/docs#31.

  • Write the Node SDK README as first-time setup rather than a v1 migration.
  • Rename the reading section to Read flags and describe the current API directly.
  • Remove rollout notices and old-wrapper comparisons; keep upgrade details in the site migration guide.

Only packages/node-sdk/README.md changes. No runtime, package version, publication or release workflow changes. This now targets main after Node SDK v2 (#790) merged. Browser/React/Vue bootstrap requires a compatible v2 consumer; v1 consumers are incompatible.

Verification

  • Canonical docs.sh regeneration succeeds with warnings treated as errors.
  • Scoped formatting, whitespace checks and normal commit hooks pass.
  • Matching declarations and generated-site checks are verified in docs Do not register received event if the prompt was already seen. #31.
  • Review follow-up 64bf707: restored the v2 bootstrap compatibility warning and documented context-only tracking controls.
  • Canonical docs regeneration, three docs-transform tests, 273 Node tests, strict compiler checks for the documented tracking examples and v1 bootstrap rejection, scoped formatting, whitespace checks and commit hooks pass.

@roncohen
roncohen marked this pull request as ready for review November 15, 2026 23:23
Copilot AI balanced review requested due to automatic review settings November 15, 2026 23:24

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot was unable to review this pull request because the user who requested the review has insufficient remaining quota.

An organization owner can choose the repository organization as the billing source for reviews requested by members with a paid Copilot license. Learn about Copilot code review billing. Review the Copilot code review billing settings.

Copilot AI balanced review requested due to automatic review settings November 16, 2026 18:48

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot was unable to review this pull request because the user who requested the review has insufficient remaining quota.

An organization owner can choose the repository organization as the billing source for reviews requested by members with a paid Copilot license. Learn about Copilot code review billing. Review the Copilot code review billing settings.

@reflag-review reflag-review Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Risk: medium

Reviewed the README-only change against the Node SDK implementation and browser bootstrap consumer. Found two newly documented integration paths that do not match the current APIs. No tests were run; review was limited to the supplied immutable snapshots.

Advisory AI review; no code was changed and no tests were executed.

Comment thread packages/node-sdk/README.md Resolved
Comment thread packages/node-sdk/README.md Resolved
Copilot AI balanced review requested due to automatic review settings November 16, 2026 19:29

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot was unable to review this pull request because the user who requested the review has insufficient remaining quota.

An organization owner can choose the repository organization as the billing source for reviews requested by members with a paid Copilot license. Learn about Copilot code review billing. Review the Copilot code review billing settings.

@reflag-review reflag-review Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Risk: medium

Reviewed the README-only change against the supplied snapshots and checked the relevant Node and browser SDK implementations. Found two documentation regressions that direct users toward incompatible bootstrap data or an ineffective tracking control. No tests were run.

Advisory AI review; no code was changed and no tests were executed.

Comment thread packages/node-sdk/README.md Resolved
Comment thread packages/node-sdk/README.md Resolved
@roncohen
roncohen added this pull request to stack #808 November 17, 2026 19:52

@reflag-review reflag-review Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Risk: medium

Reviewed the README changes against the SDK implementations. Found one newly documented integration that is incompatible with the current browser bootstrap contract. This was a read-only review; no tests were run.

Advisory AI review; no code was changed and no tests were executed.

Comment thread packages/node-sdk/README.md Resolved
Base automatically changed from feature/node-sdk-v2 to main November 18, 2026 15:04
roncohen and others added 5 commits November 18, 2026 16:04
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Give the Browser, React, Vue and Node guides a shared outline (get started,
read flags, track usage, update context, bootstrap, opt-in, toolbar, type
safety, configuration), plain-language explanations, and restore toolbar and
CSP guidance for browser frameworks.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@roncohen
roncohen force-pushed the docs/standalone-v2-node-guide branch from 81297fb to a4e6d19 Compare November 18, 2026 15:04

@reflag-review reflag-review Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Risk: medium

Reviewed the README changes against the Node and Browser SDK implementations. Found one incompatible bootstrap recommendation that can break server-to-browser flag hydration. Review was read-only; no tests were run.

Advisory AI review; no code was changed and no tests were executed.

Comment thread packages/node-sdk/README.md Resolved

@reflag-review reflag-review Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Risk: low

no actionable findings

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants