Add Optimizely docs: docs/optimizely.md and README + providers updates#145
Merged
Conversation
984ef59 to
b28b946
Compare
Base automatically changed from
feat/optimizely-hardening-and-failure-tests
to
main
May 13, 2026 16:51
ec5b1fa to
6b8dca7
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Implements #137 (D5 — Optimizely docs) from the 1.0-readiness milestone.
Stacked. Base branch is
feat/optimizely-hardening-and-failure-tests(#141). This branch also merges infeat/init-timeout-and-sync-verify(#138) andfeat/typed-errors-and-ofrep-validation(#139) so the documentation references real APIs (init timeout, validatedOptimizelyProvider.make, typedUnauthorized/Unreachableerrors). Once #138, #139, #140, and #141 land inmain, retarget tomain.What lands
docs/optimizely.md(new) — comprehensive Optimizely guide with seven sections:OptimizelyProvider.make(sdkKey)+FeatureFlags.fromProviderAsync.Fatalstatus with a polling helper.OptimizelyProvider.make(sdkKey, datafileUrl)overload.CircuitBreakerProvidercomposition with concrete config, including the infrastructure-vs-application error classification note.TestFeatureProviderfor unit tests, plus the WireMock pattern for integration tests of the Optimizely wiring itself.Unauthorized/Unreachable/Fatal/errorCode-populatedFlagResolution),ConfigurationChangedhandling, and the recommended liveness/readiness check.docs/providers.md— replaced the existing "Using Optimizely" section (which referenced the unpublished contrib provider) with a quick-start pointing atzio-openfeature-optimizely. Updated the "Other Providers" table to reference our module and link to the dedicated guide. User-targeting + feature-variables subsections rewritten against the actual API (including theopenfeature.variableKeycontext-attribute override).README.md— addedzio-openfeature-optimizelyto the installation snippet alongside OFREP. Added a "Using Optimizely Feature Experimentation" subsection with a compact runnable example. Fixed the "Popular Providers" table to point Optimizely at our module rather than the unpublished contrib artifact.Closes #137