Skip to content

chore: update sdk readmes #1327

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
openfeaturebot wants to merge 1 commit into
base: main
Choose a base branch
from
Open

chore: update sdk readmes #1327

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/reference/sdks/client/kotlin.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 Mon Jan 05 2026 08:13:26 GMT+0000 (Coordinated Universal Time)
Last updated at Tue Jan 13 2026 08:12:30 GMT+0000 (Coordinated Universal Time)
-->
import MCPInstall from '@site/src/partials/mcp-install';

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/sdks/client/swift.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 Mon Jan 05 2026 08:13:26 GMT+0000 (Coordinated Universal Time)
Last updated at Tue Jan 13 2026 08:12:30 GMT+0000 (Coordinated Universal Time)
-->
import MCPInstall from '@site/src/partials/mcp-install';

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/sdks/client/web/angular.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 Mon Jan 05 2026 08:13:26 GMT+0000 (Coordinated Universal Time)
Last updated at Tue Jan 13 2026 08:12:31 GMT+0000 (Coordinated Universal Time)
-->

<p align="center" class="github-badges">
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/sdks/client/web/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 Mon Jan 05 2026 08:13:25 GMT+0000 (Coordinated Universal Time)
Last updated at Tue Jan 13 2026 08:12:30 GMT+0000 (Coordinated Universal Time)
-->
import MCPInstall from '@site/src/partials/mcp-install';

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/sdks/client/web/react.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 Mon Jan 05 2026 08:13:25 GMT+0000 (Coordinated Universal Time)
Last updated at Tue Jan 13 2026 08:12:30 GMT+0000 (Coordinated Universal Time)
-->
import MCPInstall from '@site/src/partials/mcp-install';

Expand Down
8 changes: 4 additions & 4 deletions docs/reference/sdks/server/dart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This content has been automatically generated from dart-server-sdk.
Edits should be made here: https://github.com/open-feature/dart-server-sdk
Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs

Last updated at Mon Jan 05 2026 08:13:26 GMT+0000 (Coordinated Universal Time)
Last updated at Tue Jan 13 2026 08:12:31 GMT+0000 (Coordinated Universal Time)
-->

<p align="center" class="github-badges">
Expand All @@ -19,8 +19,8 @@ Last updated at Mon Jan 05 2026 08:13:26 GMT+0000 (Coordinated Universal Time)
</a>


<a href="https://github.com/open-feature/dart-server-sdk/releases/tag/v0.0.15">
<img alt="Release" src="https://img.shields.io/static/v1?label=release&message=v0.0.15&color=blue&style=for-the-badge" />
<a href="https://github.com/open-feature/dart-server-sdk/releases/tag/v0.0.16">
<img alt="Release" src="https://img.shields.io/static/v1?label=release&message=v0.0.16&color=blue&style=for-the-badge" />
</a>

<a href="https://dart.dev/">
Expand Down Expand Up @@ -56,7 +56,7 @@ Dart language version: [3.9.2](https://dart.dev/get-dart/archive)

```yaml
dependencies:
openfeature_dart_server_sdk: ^0.0.15
openfeature_dart_server_sdk: ^0.0.16
```

### Then run:
Expand Down
6 changes: 3 additions & 3 deletions docs/reference/sdks/server/dotnet.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,15 @@ 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 Mon Jan 05 2026 08:13:25 GMT+0000 (Coordinated Universal Time)
Last updated at Tue Jan 13 2026 08:12:29 GMT+0000 (Coordinated Universal Time)
-->
import MCPInstall from '@site/src/partials/mcp-install';


[![Specification](https://img.shields.io/static/v1?label=specification&message=v0.8.0&color=yellow&style=for-the-badge)](https://github.com/open-feature/spec/releases/tag/v0.8.0)
[
![Release](https://img.shields.io/static/v1?label=release&message=v2.11.0&color=blue&style=for-the-badge)
](https://github.com/open-feature/dotnet-sdk/releases/tag/v2.11.0)
![Release](https://img.shields.io/static/v1?label=release&message=v2.11.1&color=blue&style=for-the-badge)
](https://github.com/open-feature/dotnet-sdk/releases/tag/v2.11.1)

[![Slack](https://img.shields.io/badge/slack-%40cncf%2Fopenfeature-brightgreen?style=flat&logo=slack)](https://cloud-native.slack.com/archives/C0344AANLA1)
[![Codecov](https://codecov.io/gh/open-feature/dotnet-sdk/branch/main/graph/badge.svg?token=MONAVJBXUJ)](https://codecov.io/gh/open-feature/dotnet-sdk)
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/sdks/server/go.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 Mon Jan 05 2026 08:13:25 GMT+0000 (Coordinated Universal Time)
Last updated at Tue Jan 13 2026 08:12:29 GMT+0000 (Coordinated Universal Time)
-->
import MCPInstall from '@site/src/partials/mcp-install';

Expand Down
37 changes: 35 additions & 2 deletions docs/reference/sdks/server/java.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 Mon Jan 05 2026 08:13:25 GMT+0000 (Coordinated Universal Time)
Last updated at Tue Jan 13 2026 08:12:29 GMT+0000 (Coordinated Universal Time)
-->
import MCPInstall from '@site/src/partials/mcp-install';

Expand Down Expand Up @@ -126,6 +126,7 @@ See [here](https://javadoc.io/doc/dev.openfeature/sdk/latest/) for the Javadocs.
| ------ |---------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ✅ | [Providers](#providers) | Integrate with a commercial, open source, or in-house feature management tool. |
| ✅ | [Targeting](#targeting) | Contextually-aware flag evaluation using [evaluation context](/docs/reference/concepts/evaluation-context). |
| ✅ | [Multi-provider (experimental)](#multi-provider-experimental) | Combine multiple providers and delegate evaluations according to a strategy. |
| ✅ | [Hooks](#hooks) | Add functionality to various stages of the flag evaluation life-cycle. |
| ✅ | [Tracking](#tracking) | Associate user actions with feature flag evaluations. |
| ✅ | [Logging](#logging) | Integrate with popular logging packages. |
Expand All @@ -144,7 +145,39 @@ Look [here](/ecosystem?instant_search%5BrefinementList%5D%5Btype%5D%5B0%5D=Provi
If the provider you're looking for hasn't been created yet, see the [develop a provider](#develop-a-provider) section to learn how to build it yourself.

Once you've added a provider as a dependency, it can be registered with OpenFeature like this:


In some situations, it may be beneficial to register multiple providers in the same application.
This is possible using [domains](#domains), which is covered in more detail below.

#### Multi-provider (experimental)

In addition to domains, you may want to delegate flag evaluation across multiple providers using a configurable strategy.
The multi-provider allows you to compose several `FeatureProvider` implementations and determine which provider's result to use.

> **Experimental:** This API is experimental and may change in future releases.

```java
import dev.openfeature.sdk.OpenFeatureAPI;
import dev.openfeature.sdk.Client;
import dev.openfeature.sdk.FeatureProvider;
import dev.openfeature.sdk.multiprovider.MultiProvider;

import java.util.List;

public void multiProviderExample() throws Exception {
FeatureProvider primaryProvider = new MyPrimaryProvider();
FeatureProvider fallbackProvider = new MyFallbackProvider();

MultiProvider multiProvider = new MultiProvider(List.of(primaryProvider, fallbackProvider));

OpenFeatureAPI api = OpenFeatureAPI.getInstance();
api.setProviderAndWait(multiProvider);

Client client = api.getClient();
boolean value = client.getBooleanValue("some-flag", false);
}
```

#### Synchronous

To register a provider in a blocking manner to ensure it is ready before further actions are taken, you can use the `setProviderAndWait` method as shown below:
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/sdks/server/javascript/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 Mon Jan 05 2026 08:13:25 GMT+0000 (Coordinated Universal Time)
Last updated at Tue Jan 13 2026 08:12:29 GMT+0000 (Coordinated Universal Time)
-->
import MCPInstall from '@site/src/partials/mcp-install';

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/sdks/server/javascript/nestjs.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 Mon Jan 05 2026 08:13:25 GMT+0000 (Coordinated Universal Time)
Last updated at Tue Jan 13 2026 08:12:29 GMT+0000 (Coordinated Universal Time)
-->
import MCPInstall from '@site/src/partials/mcp-install';

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/sdks/server/php.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 Mon Jan 05 2026 08:13:25 GMT+0000 (Coordinated Universal Time)
Last updated at Tue Jan 13 2026 08:12:30 GMT+0000 (Coordinated Universal Time)
-->
import MCPInstall from '@site/src/partials/mcp-install';

Expand Down
6 changes: 3 additions & 3 deletions docs/reference/sdks/server/python.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 Mon Jan 05 2026 08:13:25 GMT+0000 (Coordinated Universal Time)
Last updated at Tue Jan 13 2026 08:12:30 GMT+0000 (Coordinated Universal Time)
-->
import MCPInstall from '@site/src/partials/mcp-install';

Expand Down Expand Up @@ -37,7 +37,7 @@ import MCPInstall from '@site/src/partials/mcp-install';
</a>

<a href="https://www.python.org/downloads/">
<img alt="Min python version" src="https://img.shields.io/badge/python->=3.9-blue.svg" />
<img alt="Min python version" src="https://img.shields.io/badge/python->=3.10-blue.svg" />
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot Jan 6, 2026

Choose a reason for hiding this comment

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

medium

The > character in the URL for the shields.io badge is not URL-encoded. While this may work in some browsers, it's not robust and can lead to broken images. It's best practice to URL-encode special characters in URLs. The > should be replaced with %3E.

    <img alt="Min python version" src="https://img.shields.io/badge/python-%3E=3.10-blue.svg" />

</a>

<a href="https://www.repostatus.org/#wip">
Expand All @@ -52,7 +52,7 @@ import MCPInstall from '@site/src/partials/mcp-install';

### Requirements

- Python 3.9+
- Python 3.10+

### Install

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/sdks/server/ruby.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 Mon Jan 05 2026 08:13:26 GMT+0000 (Coordinated Universal Time)
Last updated at Tue Jan 13 2026 08:12:30 GMT+0000 (Coordinated Universal Time)
-->
import MCPInstall from '@site/src/partials/mcp-install';

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/sdks/server/rust.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 Mon Jan 05 2026 08:13:26 GMT+0000 (Coordinated Universal Time)
Last updated at Tue Jan 13 2026 08:12:31 GMT+0000 (Coordinated Universal Time)
-->

<p align="center" class="github-badges">
Expand Down
8 changes: 4 additions & 4 deletions src/datasets/sdks/sdk-compatibility.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,8 +124,8 @@
"path": "/docs/reference/sdks/server/dotnet",
"category": "Server",
"release": {
"href": "https://github.com/open-feature/dotnet-sdk/releases/tag/v2.11.0",
"version": "2.11.0",
"href": "https://github.com/open-feature/dotnet-sdk/releases/tag/v2.11.1",
"version": "2.11.1",
"stable": true
},
"spec": {
Expand Down Expand Up @@ -592,8 +592,8 @@
"path": "/docs/reference/sdks/server/dart",
"category": "Server",
"release": {
"href": "https://github.com/open-feature/dart-server-sdk/releases/tag/v0.0.15",
"version": "0.0.15",
"href": "https://github.com/open-feature/dart-server-sdk/releases/tag/v0.0.16",
"version": "0.0.16",
"stable": false
},
"spec": {
Expand Down