Skip to content

Commit 5841d58

Browse files
chore: update sdk readmes (#1114)
The PR was automatically generated via the update-sdk-docs GitHub workflow. Signed-off-by: OpenFeature Bot <[email protected]>
1 parent 2da7866 commit 5841d58

File tree

14 files changed

+46
-33
lines changed

14 files changed

+46
-33
lines changed

docs/reference/technologies/client/kotlin.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ This content has been automatically generated from kotlin-sdk.
1010
Edits should be made here: https://github.com/open-feature/kotlin-sdk
1111
Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs
1212

13-
Last updated at Mon Apr 14 2025 08:11:06 GMT+0000 (Coordinated Universal Time)
13+
Last updated at Wed Apr 16 2025 08:10:30 GMT+0000 (Coordinated Universal Time)
1414
-->
1515

1616
<p align="center" class="github-badges">

docs/reference/technologies/client/swift.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ This content has been automatically generated from swift-sdk.
1010
Edits should be made here: https://github.com/open-feature/swift-sdk
1111
Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs
1212

13-
Last updated at Mon Apr 14 2025 08:11:06 GMT+0000 (Coordinated Universal Time)
13+
Last updated at Wed Apr 16 2025 08:10:30 GMT+0000 (Coordinated Universal Time)
1414
-->
1515

1616
<p align="center" class="github-badges">

docs/reference/technologies/client/web/angular.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ This content has been automatically generated from js-sdk.
1010
Edits should be made here: https://github.com/open-feature/js-sdk
1111
Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs
1212

13-
Last updated at Mon Apr 14 2025 08:11:07 GMT+0000 (Coordinated Universal Time)
13+
Last updated at Wed Apr 16 2025 08:10:31 GMT+0000 (Coordinated Universal Time)
1414
-->
1515

1616
<p align="center" class="github-badges">
@@ -153,7 +153,7 @@ This parameter is optional, if omitted, the `thenTemplate` will always be render
153153
The `domain` parameter is _optional_ and will be used as domain when getting the OpenFeature provider.
154154

155155
The `updateOnConfigurationChanged` and `updateOnContextChanged` parameter are _optional_ and used to disable the
156-
automatic re-rendering on flag value or contex change. They are set to `true` by default.
156+
automatic re-rendering on flag value or context change. They are set to `true` by default.
157157

158158
The template referenced in `else` will be rendered if the evaluated feature flag is `false` for the `booleanFeatureFlag`
159159
directive and if the `value` does not match evaluated flag value for all other directives.

docs/reference/technologies/client/web/index.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,16 @@ This content has been automatically generated from js-sdk.
1010
Edits should be made here: https://github.com/open-feature/js-sdk
1111
Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs
1212

13-
Last updated at Mon Apr 14 2025 08:11:06 GMT+0000 (Coordinated Universal Time)
13+
Last updated at Wed Apr 16 2025 08:10:30 GMT+0000 (Coordinated Universal Time)
1414
-->
1515

1616
<p align="center" class="github-badges">
1717
<a href="https://github.com/open-feature/spec/releases/tag/v0.8.0">
1818
<img alt="Specification" src="https://img.shields.io/static/v1?label=specification&message=v0.8.0&color=yellow&style=for-the-badge" />
1919
</a>
2020

21-
<a href="https://github.com/open-feature/js-sdk/releases/tag/web-sdk-v1.4.1">
22-
<img alt="Release" src="https://img.shields.io/static/v1?label=release&message=v1.4.1&color=blue&style=for-the-badge" />
21+
<a href="https://github.com/open-feature/js-sdk/releases/tag/web-sdk-v1.5.0">
22+
<img alt="Release" src="https://img.shields.io/static/v1?label=release&message=v1.5.0&color=blue&style=for-the-badge" />
2323
</a>
2424

2525
<br/>

docs/reference/technologies/client/web/react.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,16 @@ This content has been automatically generated from js-sdk.
1010
Edits should be made here: https://github.com/open-feature/js-sdk
1111
Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs
1212

13-
Last updated at Mon Apr 14 2025 08:11:06 GMT+0000 (Coordinated Universal Time)
13+
Last updated at Wed Apr 16 2025 08:10:30 GMT+0000 (Coordinated Universal Time)
1414
-->
1515

1616
<p align="center" class="github-badges">
1717
<a href="https://github.com/open-feature/spec/releases/tag/v0.8.0">
1818
<img alt="Specification" src="https://img.shields.io/static/v1?label=specification&message=v0.8.0&color=yellow&style=for-the-badge" />
1919
</a>
2020

21-
<a href="https://github.com/open-feature/js-sdk/releases/tag/react-sdk-v0.4.11">
22-
<img alt="Release" src="https://img.shields.io/static/v1?label=release&message=v0.4.11&color=blue&style=for-the-badge" />
21+
<a href="https://github.com/open-feature/js-sdk/releases/tag/react-sdk-v1.0.0">
22+
<img alt="Release" src="https://img.shields.io/static/v1?label=release&message=v1.0.0&color=blue&style=for-the-badge" />
2323
</a>
2424

2525
<br/>

docs/reference/technologies/server/dotnet.mdx

Lines changed: 28 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,13 @@ This content has been automatically generated from dotnet-sdk.
1010
Edits should be made here: https://github.com/open-feature/dotnet-sdk
1111
Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs
1212

13-
Last updated at Mon Apr 14 2025 08:11:05 GMT+0000 (Coordinated Universal Time)
13+
Last updated at Wed Apr 16 2025 08:10:29 GMT+0000 (Coordinated Universal Time)
1414
-->
1515

1616
[![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)
1717
[
18-
![Release](https://img.shields.io/static/v1?label=release&message=v2.3.2&color=blue&style=for-the-badge)
19-
](https://github.com/open-feature/dotnet-sdk/releases/tag/v2.3.2)
18+
![Release](https://img.shields.io/static/v1?label=release&message=v2.4.0&color=blue&style=for-the-badge)
19+
](https://github.com/open-feature/dotnet-sdk/releases/tag/v2.4.0)
2020

2121
[![Slack](https://img.shields.io/badge/slack-%40cncf%2Fopenfeature-brightgreen?style=flat&logo=slack)](https://cloud-native.slack.com/archives/C0344AANLA1)
2222
[![Codecov](https://codecov.io/gh/open-feature/dotnet-sdk/branch/main/graph/badge.svg?token=MONAVJBXUJ)](https://codecov.io/gh/open-feature/dotnet-sdk)
@@ -71,17 +71,17 @@ public async Task Example()
7171

7272
| Status | Features | Description |
7373
| ------ | ------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
74-
| | [Providers](#providers) | Integrate with a commercial, open source, or in-house feature management tool. |
75-
| | [Targeting](#targeting) | Contextually-aware flag evaluation using [evaluation context](/docs/reference/concepts/evaluation-context). |
76-
| | [Hooks](#hooks) | Add functionality to various stages of the flag evaluation life-cycle. |
77-
| | [Tracking](#tracking) | Associate user actions with feature flag evaluations. |
78-
| | [Logging](#logging) | Integrate with popular logging packages. |
79-
| | [Domains](#domains) | Logically bind clients with providers. |
80-
| | [Eventing](#eventing) | React to state changes in the provider or flag management system. |
81-
| | [Shutdown](#shutdown) | Gracefully clean up a provider during application shutdown. |
82-
| | [Transaction Context Propagation](#transaction-context-propagation) | Set a specific [evaluation context](/docs/reference/concepts/evaluation-context) for a transaction (e.g. an HTTP request or a thread). |
83-
| | [Extending](#extending) | Extend OpenFeature with custom providers and hooks. |
84-
| 🔬 | [DependencyInjection](#DependencyInjection) | Integrate OpenFeature with .NET's dependency injection for streamlined provider setup. |
74+
| | [Providers](#providers) | Integrate with a commercial, open source, or in-house feature management tool. |
75+
| | [Targeting](#targeting) | Contextually-aware flag evaluation using [evaluation context](/docs/reference/concepts/evaluation-context). |
76+
| | [Hooks](#hooks) | Add functionality to various stages of the flag evaluation life-cycle. |
77+
| | [Tracking](#tracking) | Associate user actions with feature flag evaluations. |
78+
| | [Logging](#logging) | Integrate with popular logging packages. |
79+
| | [Domains](#domains) | Logically bind clients with providers. |
80+
| | [Eventing](#eventing) | React to state changes in the provider or flag management system. |
81+
| | [Shutdown](#shutdown) | Gracefully clean up a provider during application shutdown. |
82+
| | [Transaction Context Propagation](#transaction-context-propagation) | Set a specific [evaluation context](/docs/reference/concepts/evaluation-context) for a transaction (e.g. an HTTP request or a thread). |
83+
| | [Extending](#extending) | Extend OpenFeature with custom providers and hooks. |
84+
| 🔬 | [DependencyInjection](#DependencyInjection) | Integrate OpenFeature with .NET's dependency injection for streamlined provider setup. |
8585

8686
> Implemented: ✅ | In-progress: ⚠️ | Not implemented yet: ❌ | Experimental: 🔬
8787

@@ -153,6 +153,7 @@ var value = await client.GetBooleanValueAsync("boolFlag", false, context, new Fl
153153
### Logging
154154

155155
The .NET SDK uses Microsoft.Extensions.Logging. See the [manual](https://learn.microsoft.com/en-us/dotnet/core/extensions/logging?tabs=command-line) for complete documentation.
156+
Note that in accordance with the OpenFeature specification, the SDK doesn't generally log messages during flag evaluation. If you need further troubleshooting, please look into the `Logging Hook` section.
156157

157158
#### Logging Hook
158159

@@ -165,6 +166,7 @@ var logger = loggerFactory.CreateLogger("Program");
165166
var client = Api.Instance.GetClient();
166167
client.AddHooks(new LoggingHook(logger));
167168
```
169+
168170
See [hooks](#hooks) for more information on configuring hooks.
169171

170172
### Domains
@@ -260,6 +262,7 @@ To register a [AsyncLocal](https://learn.microsoft.com/en-us/dotnet/api/system.t
260262
// registering the AsyncLocalTransactionContextPropagator
261263
Api.Instance.SetTransactionContextPropagator(new AsyncLocalTransactionContextPropagator());
262264
```
265+
263266
Once you've registered a transaction context propagator, you can propagate the data into request-scoped transaction context.
264267

265268
```csharp
@@ -269,6 +272,7 @@ EvaluationContext transactionContext = EvaluationContext.Builder()
269272
.Build();
270273
Api.Instance.SetTransactionContext(transactionContext);
271274
```
275+
272276
Additionally, you can develop a custom transaction context propagator by implementing the `TransactionContextPropagator` interface and registering it as shown above.
273277

274278
## Extending
@@ -352,19 +356,25 @@ public class MyHook : Hook
352356
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!
353357

354358
### DependencyInjection
359+
355360
> [!NOTE]
356361
> The OpenFeature.DependencyInjection and OpenFeature.Hosting packages are currently experimental. They streamline the integration of OpenFeature within .NET applications, allowing for seamless configuration and lifecycle management of feature flag providers using dependency injection and hosting services.
357362
358363
#### Installation
364+
359365
To set up dependency injection and hosting capabilities for OpenFeature, install the following packages:
366+
360367
```sh
361368
dotnet add package OpenFeature.DependencyInjection
362369
dotnet add package OpenFeature.Hosting
363370
```
371+
364372
#### Usage Examples
373+
365374
For a basic configuration, you can use the InMemoryProvider. This provider is simple and well-suited for development and testing purposes.
366375

367376
**Basic Configuration:**
377+
368378
```csharp
369379
builder.Services.AddOpenFeature(featureBuilder => {
370380
featureBuilder
@@ -373,8 +383,10 @@ builder.Services.AddOpenFeature(featureBuilder => {
373383
.AddInMemoryProvider();
374384
});
375385
```
386+
376387
**Domain-Scoped Provider Configuration:**
377388
<br />To set up multiple providers with a selection policy, define logic for choosing the default provider. This example designates `name1` as the default provider:
389+
378390
```csharp
379391
builder.Services.AddOpenFeature(featureBuilder => {
380392
featureBuilder
@@ -390,6 +402,7 @@ builder.Services.AddOpenFeature(featureBuilder => {
390402
```
391403

392404
### Registering a Custom Provider
405+
393406
You can register a custom provider, such as `InMemoryProvider`, with OpenFeature using the `AddProvider` method. This approach allows you to dynamically resolve services or configurations during registration.
394407

395408
```csharp
@@ -407,7 +420,7 @@ services.AddOpenFeature(builder =>
407420
// Register a custom provider, such as InMemoryProvider
408421
return new InMemoryProvider(flags);
409422
});
410-
});
423+
});
411424
```
412425

413426
#### Adding a Domain-Scoped Provider

docs/reference/technologies/server/go.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ This content has been automatically generated from go-sdk.
99
Edits should be made here: https://github.com/open-feature/go-sdk
1010
Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs
1111

12-
Last updated at Mon Apr 14 2025 08:11:05 GMT+0000 (Coordinated Universal Time)
12+
Last updated at Wed Apr 16 2025 08:10:29 GMT+0000 (Coordinated Universal Time)
1313
-->
1414

1515
<p align="center" class="github-badges">

docs/reference/technologies/server/java.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ This content has been automatically generated from java-sdk.
99
Edits should be made here: https://github.com/open-feature/java-sdk
1010
Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs
1111

12-
Last updated at Mon Apr 14 2025 08:11:05 GMT+0000 (Coordinated Universal Time)
12+
Last updated at Wed Apr 16 2025 08:10:28 GMT+0000 (Coordinated Universal Time)
1313
-->
1414

1515
<p align="center" class="github-badges">

docs/reference/technologies/server/javascript/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ This content has been automatically generated from js-sdk.
1010
Edits should be made here: https://github.com/open-feature/js-sdk
1111
Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs
1212

13-
Last updated at Mon Apr 14 2025 08:11:05 GMT+0000 (Coordinated Universal Time)
13+
Last updated at Wed Apr 16 2025 08:10:29 GMT+0000 (Coordinated Universal Time)
1414
-->
1515

1616
<p align="center" class="github-badges">

docs/reference/technologies/server/javascript/nestjs.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ This content has been automatically generated from js-sdk.
1010
Edits should be made here: https://github.com/open-feature/js-sdk
1111
Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs
1212

13-
Last updated at Mon Apr 14 2025 08:11:05 GMT+0000 (Coordinated Universal Time)
13+
Last updated at Wed Apr 16 2025 08:10:29 GMT+0000 (Coordinated Universal Time)
1414
-->
1515

1616
<p align="center" class="github-badges">

0 commit comments

Comments
 (0)