Skip to content

docs: write framework SDK guides for new integrations - #806

Draft
roncohen wants to merge 41 commits into
mainfrom
docs/standalone-v2-framework-guides
Draft

roncohen wants to merge 41 commits into
mainfrom
docs/standalone-v2-framework-guides

Conversation

@roncohen

Copy link
Copy Markdown
Contributor

Summary

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

  • Treat Browser, React and Vue documentation as first-time SDK setup, rather than a v1 migration.
  • Add ordinary, unpinned install commands; use neutral headings and positive API descriptions.
  • Keep upgrade comparisons in the dedicated site migration guide. The site importer supplies one short legacy/upgrade link at the bottom of each page.

Only three SDK READMEs change. No runtime, package version, publication or release workflow changes. This is stacked on the framework v2 feature branch, not main.

Verification

Keep published evaluator 2.0.0 and main's dependency updates, port ETag revalidation and initialization diagnostics to complete collections, preserve application-owned shutdown, and address the three Node migration review regressions. Keep OpenFeature and the v1 bootstrap demo isolated on published Node 1.8.3.
Preserve Browser/React/Vue v2 transport, direct values and bootstrap APIs while carrying forward main's initialization diagnostics, readable opt-in error responses, security updates and test cleanup. Keep legacy framework consumers on published v1 and validate the combined Node-to-Browser bootstrap contract.
Use the matched React/Browser v2 toolchain, direct-value hooks and protocol-v2 bootstrap while retaining Native storage and SSE adapters. Migrate Expo/bare examples and add mandatory Native runtime/type coverage plus a major Changeset.
roncohen and others added 4 commits November 16, 2026 18:12
Resolve the OpenFeature example's Next CLI from its own module context for dev, build and start so Yarn cannot mix virtual-package runtimes. Add mandatory launcher regression tests and isolate them from the SDK's Vitest runner.

Share React Native provider defaults, remove redundant fixture state and casts, and drop the unused direct Browser development dependency.
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>
roncohen and others added 3 commits November 16, 2026 20:11
Describe Browser, React, Vue and React Native v2 in terms of public APIs and migration requirements. Fold the registered-defaults patch note into the Browser/framework major entry.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@roncohen
roncohen added this pull request to stack #792 November 17, 2026 19:52
@roncohen

Copy link
Copy Markdown
Contributor Author

Resolved the three README conflicts and pushed 6055608 plus 185ff69, merging the current framework base (158f36b) and main (604e610) without rewriting history.

Kept the first-time integration structure while preserving the newer v2 bootstrap/live-update requirements, missing opt-in metadata behavior, mutation Response/error handling, and main’s removal of the Vue beta label. No SDK runtime, package-version, or release-policy edits were introduced. The current stacked diff also inherits main’s existing #809 test-reporter change; against main plus #791, only the three SDK READMEs differ.

Validation: canonical docs regeneration with warnings treated as errors; 3 docs-transform tests; 311 runtime tests (Browser 269, React 27, Vue 15) and their compiler programs; evaluator, Node, Browser, React, Vue, and Native builds; scoped formatting, whitespace checks, and normal merge-commit hooks pass.

Left the existing PR target unchanged because #791 remains open. If #791 is squash-merged, sync/rebase onto that actual main merge commit before retargeting; that future sync is not yet complete.

Base automatically changed from feature/browser-framework-sdk-v2 to main November 19, 2026 14:16
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.

1 participant