chore: update sdk readmes (#999)

openfeaturebot · web-flow · commit ddb60c51d9c5 · 2025-03-06T19:45:48.000Z
The PR was automatically generated via the update-sdk-docs GitHub
workflow.

Signed-off-by: OpenFeature Bot &lt;109696520+openfeaturebot@users.noreply.github.com&gt;
diff --git a/docs/reference/technologies/client/kotlin.mdx b/docs/reference/technologies/client/kotlin.mdx
@@ -10,7 +10,7 @@ This content has been automatically generated from kotlin-sdk.
 Edits should be made here: https://github.com/open-feature/kotlin-sdk
 Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs
 
-Last updated at Wed Feb 19 2025 13:28:34 GMT+0000 (Coordinated Universal Time)
+Last updated at Thu Mar 06 2025 08:09:49 GMT+0000 (Coordinated Universal Time)
 -->
 
 <p align="center" class="github-badges">
@@ -72,7 +72,7 @@ coroutineScope.launch(Dispatchers.IO) {
 | ✅      | [Tracking](#tracking)           | Associate user actions with feature flag evaluations.                                                                              |
 | ❌      | [Logging](#logging)             | Integrate with popular logging packages.                                                                                           |
 | ❌      | [Named clients](#named-clients) | Utilize multiple providers in a single application.                                                                                |
-| ❌      | [Eventing](#eventing)           | React to state changes in the provider or flag management system.                                                                  |
+| ✅      | [Eventing](#eventing)           | React to state changes in the provider or flag management system.                                                                  |
 | ✅      | [Shutdown](#shutdown)           | Gracefully clean up a provider during application shutdown.                                                                        |
 | ⚠️     | [Extending](#extending)         | Extend OpenFeature with custom providers and hooks.                                                                                |
 
@@ -167,13 +167,35 @@ Tracking is optionally implemented by Providers.
 
 Logging customization is not yet available in the Kotlin SDK.
 
+It is possible to write and inject logging `Hook`s to log events at different stages of the flag evaluation life-cycle.
+
 ### Named clients
 
 Support for named clients is not yet available in the Kotlin SDK.
 
 ### Eventing
 
-Support for eventing is not yet available in the Kotlin SDK.
+Events from the Provider allow the SDK to react to state changes in the provider or underlying flag management system, such as flag definition changes, provider readiness, or error conditions.
+Events are optional which mean that not all Providers will emit them and it is not a must have. Some providers support additional events, such as `PROVIDER_CONFIGURATION_CHANGED`.
+
+Please refer to the documentation of the provider you're using to see what events are supported.
+
+Example usage:
+```kotlin
+viewModelScope.launch {
+  OpenFeatureAPI.observe().collect {
+    println(">> Provider event received")
+  }
+}
+
+viewModelScope.launch {
+  OpenFeatureAPI.setProviderAndWait(
+    MyFeatureProvider(),
+    Dispatchers.IO,
+    myEvaluationContext
+  )
+}
+```
 
 ### Shutdown
 
@@ -240,6 +262,18 @@ class NewProvider(override val hooks: List<Hook<*>>, override val metadata: Meta
     override suspend fun onContextSet(oldContext: EvaluationContext?, newContext: EvaluationContext) {
         // add necessary changes on context change
     }
+  
+    override fun track(
+      trackingEventName: String,
+      context: EvaluationContext?,
+      details: TrackingEventDetails?
+    ) {
+      // Optionally track an event
+    }
+  
+    override fun observe(): Flow<OpenFeatureProviderEvents> {
+        // Optionally return a `Flow` of OpenFeatureProviderEvents
+    }
 }
 ```
 
diff --git a/docs/reference/technologies/client/swift.mdx b/docs/reference/technologies/client/swift.mdx
@@ -10,7 +10,7 @@ This content has been automatically generated from swift-sdk.
 Edits should be made here: https://github.com/open-feature/swift-sdk
 Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs
 
-Last updated at Wed Feb 19 2025 13:28:34 GMT+0000 (Coordinated Universal Time)
+Last updated at Thu Mar 06 2025 08:09:49 GMT+0000 (Coordinated Universal Time)
 -->
 
 <p align="center" class="github-badges">
diff --git a/docs/reference/technologies/client/web/angular.mdx b/docs/reference/technologies/client/web/angular.mdx
@@ -10,7 +10,7 @@ This content has been automatically generated from js-sdk.
 Edits should be made here: https://github.com/open-feature/js-sdk
 Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs
 
-Last updated at Wed Feb 19 2025 13:28:34 GMT+0000 (Coordinated Universal Time)
+Last updated at Thu Mar 06 2025 08:09:50 GMT+0000 (Coordinated Universal Time)
 -->
 
 <p align="center" class="github-badges">
diff --git a/docs/reference/technologies/client/web/index.mdx b/docs/reference/technologies/client/web/index.mdx
@@ -10,7 +10,7 @@ This content has been automatically generated from js-sdk.
 Edits should be made here: https://github.com/open-feature/js-sdk
 Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs
 
-Last updated at Wed Feb 19 2025 13:28:33 GMT+0000 (Coordinated Universal Time)
+Last updated at Thu Mar 06 2025 08:09:49 GMT+0000 (Coordinated Universal Time)
 -->
 
 <p align="center" class="github-badges">
diff --git a/docs/reference/technologies/client/web/react.mdx b/docs/reference/technologies/client/web/react.mdx
@@ -10,7 +10,7 @@ This content has been automatically generated from js-sdk.
 Edits should be made here: https://github.com/open-feature/js-sdk
 Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs
 
-Last updated at Wed Feb 19 2025 13:28:33 GMT+0000 (Coordinated Universal Time)
+Last updated at Thu Mar 06 2025 08:09:49 GMT+0000 (Coordinated Universal Time)
 -->
 
 <p align="center" class="github-badges">
diff --git a/docs/reference/technologies/server/dotnet.mdx b/docs/reference/technologies/server/dotnet.mdx
@@ -10,7 +10,7 @@ This content has been automatically generated from dotnet-sdk.
 Edits should be made here: https://github.com/open-feature/dotnet-sdk
 Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs
 
-Last updated at Wed Feb 19 2025 13:28:32 GMT+0000 (Coordinated Universal Time)
+Last updated at Thu Mar 06 2025 08:09:48 GMT+0000 (Coordinated Universal Time)
 -->
 
 [![Specification](https://img.shields.io/static/v1?label=specification&message=v0.7.0&color=yellow&style=for-the-badge)](https://github.com/open-feature/spec/releases/tag/v0.7.0)
diff --git a/docs/reference/technologies/server/go.mdx b/docs/reference/technologies/server/go.mdx
@@ -9,7 +9,7 @@ This content has been automatically generated from go-sdk.
 Edits should be made here: https://github.com/open-feature/go-sdk
 Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs
 
-Last updated at Wed Feb 19 2025 13:28:33 GMT+0000 (Coordinated Universal Time)
+Last updated at Thu Mar 06 2025 08:09:48 GMT+0000 (Coordinated Universal Time)
 -->
 
 <p align="center" class="github-badges">
diff --git a/docs/reference/technologies/server/java.mdx b/docs/reference/technologies/server/java.mdx
@@ -9,7 +9,7 @@ This content has been automatically generated from java-sdk.
 Edits should be made here: https://github.com/open-feature/java-sdk
 Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs
 
-Last updated at Wed Feb 19 2025 13:28:32 GMT+0000 (Coordinated Universal Time)
+Last updated at Thu Mar 06 2025 08:09:48 GMT+0000 (Coordinated Universal Time)
 -->
 
 <p align="center" class="github-badges">
diff --git a/docs/reference/technologies/server/javascript/index.mdx b/docs/reference/technologies/server/javascript/index.mdx
@@ -10,7 +10,7 @@ This content has been automatically generated from js-sdk.
 Edits should be made here: https://github.com/open-feature/js-sdk
 Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs
 
-Last updated at Wed Feb 19 2025 13:28:32 GMT+0000 (Coordinated Universal Time)
+Last updated at Thu Mar 06 2025 08:09:48 GMT+0000 (Coordinated Universal Time)
 -->
 
 <p align="center" class="github-badges">
diff --git a/docs/reference/technologies/server/javascript/nestjs.mdx b/docs/reference/technologies/server/javascript/nestjs.mdx
@@ -10,7 +10,7 @@ This content has been automatically generated from js-sdk.
 Edits should be made here: https://github.com/open-feature/js-sdk
 Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs
 
-Last updated at Wed Feb 19 2025 13:28:32 GMT+0000 (Coordinated Universal Time)
+Last updated at Thu Mar 06 2025 08:09:48 GMT+0000 (Coordinated Universal Time)
 -->
 
 <p align="center" class="github-badges">
diff --git a/docs/reference/technologies/server/php.mdx b/docs/reference/technologies/server/php.mdx
@@ -9,7 +9,7 @@ This content has been automatically generated from php-sdk.
 Edits should be made here: https://github.com/open-feature/php-sdk
 Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs
 
-Last updated at Wed Feb 19 2025 13:28:33 GMT+0000 (Coordinated Universal Time)
+Last updated at Thu Mar 06 2025 08:09:49 GMT+0000 (Coordinated Universal Time)
 -->
 
 <p align="center" class="github-badges">
diff --git a/docs/reference/technologies/server/python.mdx b/docs/reference/technologies/server/python.mdx
@@ -9,7 +9,7 @@ This content has been automatically generated from python-sdk.
 Edits should be made here: https://github.com/open-feature/python-sdk
 Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs
 
-Last updated at Wed Feb 19 2025 13:28:33 GMT+0000 (Coordinated Universal Time)
+Last updated at Thu Mar 06 2025 08:09:49 GMT+0000 (Coordinated Universal Time)
 -->
 
 <p align="center" class="github-badges">
diff --git a/docs/reference/technologies/server/ruby.mdx b/docs/reference/technologies/server/ruby.mdx
@@ -10,7 +10,7 @@ This content has been automatically generated from ruby-sdk.
 Edits should be made here: https://github.com/open-feature/ruby-sdk
 Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs
 
-Last updated at Wed Feb 19 2025 13:28:34 GMT+0000 (Coordinated Universal Time)
+Last updated at Thu Mar 06 2025 08:09:49 GMT+0000 (Coordinated Universal Time)
 -->
 
 <p align="center" class="github-badges">
diff --git a/docs/reference/technologies/server/rust.mdx b/docs/reference/technologies/server/rust.mdx
@@ -9,7 +9,7 @@ This content has been automatically generated from rust-sdk.
 Edits should be made here: https://github.com/open-feature/rust-sdk
 Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs
 
-Last updated at Fri Feb 21 2025 08:42:03 GMT-0500 (Eastern Standard Time)
+Last updated at Thu Mar 06 2025 08:09:50 GMT+0000 (Coordinated Universal Time)
 -->
 
 <p align="center" class="github-badges">
@@ -21,6 +21,7 @@ Last updated at Fri Feb 21 2025 08:42:03 GMT-0500 (Eastern Standard Time)
     <img alt="Release" src="https://img.shields.io/static/v1?label=release&message=v0.2.5&color=blue&style=for-the-badge" />
   </a>
   
+
   <br/>
   <!-- TODO: update this when we have it set up
   <a href="https://bestpractices.coreinfrastructure.org/projects/6601">
@@ -42,8 +43,7 @@ Last updated at Fri Feb 21 2025 08:42:03 GMT-0500 (Eastern Standard Time)
 
 ### Requirements
 
-This package was built with Rust version `1.70.0`.
-Earlier versions might work, but is not guaranteed.
+This package was built with Rust version `1.70.0`. Earlier versions might work, but is not guaranteed.
 
 ### Install
 
@@ -132,13 +132,9 @@ async fn extended_example() {
 
 #### Getting a Struct from a Provider
 
-It is possible to extract a struct from the provider.
-Internally, this SDK defines a type `StructValue` to store any structure value.
-The `client.get_struct_value()` functions takes a type parameter `T`.
-It will try to parse `StructValue` resolved by the provider to `T`, as long as `T` implements trait `TryFrom<StructValue>`.
+It is possible to extract a struct from the provider. Internally, this SDK defines a type `StructValue` to store any structure value. The `client.get_struct_value()` functions takes a type parameter `T`. It will try to parse `StructValue` resolved by the provider to `T`, as long as `T` implements trait `TryFrom<StructValue>`.
 
-You can pass in a type that satisfies this trait bound.
-When the conversion fails, it returns an `Err` with `EvaluationReason::TypeMismatch`.
+You can pass in a type that satisfies this trait bound. When the conversion fails, it returns an `Err` with `EvaluationReason::TypeMismatch`.
 
 ### API Reference
 
@@ -309,7 +305,6 @@ let client = api.create_named_client("named");
 
 assert_eq!(client.get_int_value("key", None, None).await.unwrap(), 42);
 ```
-
 ### Eventing
 
 Events are not yet available in the Rust SDK.
@@ -400,3 +395,4 @@ impl Hook for MyHook {
 ```
 
 > Built a new hook? [Let us know](https://github.com/open-feature/openfeature.dev/issues/new?assignees=&labels=hook&projects=&template=document-hook.yaml&title=%5BHook%5D%3A+) so we can add it to the docs!
+
diff --git a/src/datasets/sdks/sdk-compatibility.json b/src/datasets/sdks/sdk-compatibility.json
@@ -422,7 +422,7 @@
         "path": "/docs/reference/technologies/client/kotlin#named-clients"
       },
       "Eventing": {
-        "status": "❌",
+        "status": "✅",
         "path": "/docs/reference/technologies/client/kotlin#eventing"
       },
       "Tracking": {
