Skip to content

chore: update sdk readmes #1336

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

Merged
beeme1mr merged 1 commit into from
Feb 18, 2026
Merged

chore: update sdk readmes #1336

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 Wed Feb 11 2026 08:22:25 GMT+0000 (Coordinated Universal Time)
Last updated at Wed Feb 18 2026 08:21:16 GMT+0000 (Coordinated Universal Time)
-->
import MCPInstall from '@site/src/partials/mcp-install';

Expand Down
38 changes: 35 additions & 3 deletions 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 Wed Feb 11 2026 08:22:26 GMT+0000 (Coordinated Universal Time)
Last updated at Wed Feb 18 2026 08:21:16 GMT+0000 (Coordinated Universal Time)
-->
import MCPInstall from '@site/src/partials/mcp-install';

Expand Down Expand Up @@ -113,7 +113,7 @@ Task {
| ✅ | [Targeting](#targeting) | Contextually-aware flag evaluation using [evaluation context](/docs/reference/concepts/evaluation-context). |
| ✅ | [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. |
| ✅ | [Logging](#logging) | Integrate with popular logging packages. |
| ❌ | [Domains](#domains) | Logically bind clients with providers. |
| ✅ | [MultiProvider](#multiprovider) | Combine multiple providers with configurable evaluation strategies. |
| ✅ | [Eventing](#eventing) | React to state changes in the provider or flag management system. |
Expand Down Expand Up @@ -192,7 +192,39 @@ Note that some providers may not support tracking; check the documentation for y

### Logging

Logging customization is not yet available in the iOS SDK.
The iOS SDK integrates with [swift-log](https://github.com/apple/swift-log), the standard logging API for Swift. This provides a unified, cross-platform logging interface that works with any swift-log compatible backend.

#### Configure Logger

You can configure logging at three levels, with each level taking precedence over the previous:

**1. Global (API-level)** - affects all flag evaluations:
```swift
import Logging

let logger = Logger(label: "com.example.app.openfeature")
OpenFeatureAPI.shared.setLogger(logger)
```

**2. Client-level** - affects all evaluations from a specific client:
```swift
let client = OpenFeatureAPI.shared.getClient()
let logger = Logger(label: "com.example.app.flags")
client.setLogger(logger)
```

**3. Evaluation-level** - affects a single flag evaluation:
```swift
let logger = Logger(label: "com.example.app.critical-flag")
let options = FlagEvaluationOptions(logger: logger)
let value = client.getBooleanValue(key: "my-flag", defaultValue: false, options: options)
```

#### Provider Support

Providers can optionally use the logger for debugging and diagnostics. The logger is passed to providers during flag evaluation, allowing them to log relevant information.

If no logger is configured, logging is disabled. The logger is completely optional for both SDK users and provider authors.

### Domains

Expand Down
6 changes: 3 additions & 3 deletions 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,16 +10,16 @@ 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 11 2026 08:22:26 GMT+0000 (Coordinated Universal Time)
Last updated at Wed Feb 18 2026 08:21:16 GMT+0000 (Coordinated Universal Time)
-->

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

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

<br/>
Expand Down
6 changes: 3 additions & 3 deletions 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 Wed Feb 11 2026 08:22:25 GMT+0000 (Coordinated Universal Time)
Last updated at Wed Feb 18 2026 08:21:16 GMT+0000 (Coordinated Universal Time)
-->
import MCPInstall from '@site/src/partials/mcp-install';

Expand All @@ -20,8 +20,8 @@ import MCPInstall from '@site/src/partials/mcp-install';
<img alt="Specification" src="https://img.shields.io/static/v1?label=specification&message=v0.8.0&color=yellow&style=for-the-badge" />
</a>

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

<br/>
Expand Down
6 changes: 3 additions & 3 deletions 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 Wed Feb 11 2026 08:22:25 GMT+0000 (Coordinated Universal Time)
Last updated at Wed Feb 18 2026 08:21:16 GMT+0000 (Coordinated Universal Time)
-->
import MCPInstall from '@site/src/partials/mcp-install';

Expand All @@ -20,8 +20,8 @@ import MCPInstall from '@site/src/partials/mcp-install';
<img alt="Specification" src="https://img.shields.io/static/v1?label=specification&message=v0.8.0&color=yellow&style=for-the-badge" />
</a>

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

<br/>
Expand Down
2 changes: 1 addition & 1 deletion 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 Wed Feb 11 2026 08:22:26 GMT+0000 (Coordinated Universal Time)
Last updated at Wed Feb 18 2026 08:21:16 GMT+0000 (Coordinated Universal Time)
-->

<p align="center" class="github-badges">
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/sdks/server/dotnet.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 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 11 2026 08:22:25 GMT+0000 (Coordinated Universal Time)
Last updated at Wed Feb 18 2026 08:21:15 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/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 Wed Feb 11 2026 08:22:25 GMT+0000 (Coordinated Universal Time)
Last updated at Wed Feb 18 2026 08:21:15 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/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 Wed Feb 11 2026 08:22:25 GMT+0000 (Coordinated Universal Time)
Last updated at Wed Feb 18 2026 08:21:15 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/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 Wed Feb 11 2026 08:22:25 GMT+0000 (Coordinated Universal Time)
Last updated at Wed Feb 18 2026 08:21:15 GMT+0000 (Coordinated Universal Time)
-->
import MCPInstall from '@site/src/partials/mcp-install';

Expand All @@ -20,8 +20,8 @@ import MCPInstall from '@site/src/partials/mcp-install';
<img alt="Specification" src="https://img.shields.io/static/v1?label=specification&message=v0.8.0&color=yellow&style=for-the-badge" />
</a>

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

<br/>
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 Wed Feb 11 2026 08:22:25 GMT+0000 (Coordinated Universal Time)
Last updated at Wed Feb 18 2026 08:21:15 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 Wed Feb 11 2026 08:22:25 GMT+0000 (Coordinated Universal Time)
Last updated at Wed Feb 18 2026 08:21:15 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/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 Wed Feb 11 2026 08:22:25 GMT+0000 (Coordinated Universal Time)
Last updated at Wed Feb 18 2026 08:21:15 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/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 Wed Feb 11 2026 08:22:26 GMT+0000 (Coordinated Universal Time)
Last updated at Wed Feb 18 2026 08:21:16 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 Wed Feb 11 2026 08:22:26 GMT+0000 (Coordinated Universal Time)
Last updated at Wed Feb 18 2026 08:21:17 GMT+0000 (Coordinated Universal Time)
-->

<p align="center" class="github-badges">
Expand Down
10 changes: 5 additions & 5 deletions src/datasets/sdks/sdk-compatibility.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,8 +64,8 @@
"path": "/docs/reference/sdks/server/javascript",
"category": "Server",
"release": {
"href": "https://github.com/open-feature/js-sdk/releases/tag/server-sdk-v1.20.1",
"version": "1.20.1",
"href": "https://github.com/open-feature/js-sdk/releases/tag/server-sdk-v1.20.2",
"version": "1.20.2",
"stable": true
},
"spec": {
Expand Down Expand Up @@ -364,8 +364,8 @@
"path": "/docs/reference/sdks/client/web",
"category": "Client",
"release": {
"href": "https://github.com/open-feature/js-sdk/releases/tag/web-sdk-v1.7.2",
"version": "1.7.2",
"href": "https://github.com/open-feature/js-sdk/releases/tag/web-sdk-v1.7.3",
"version": "1.7.3",
"stable": true
},
"spec": {
Expand Down Expand Up @@ -498,7 +498,7 @@
"path": "/docs/reference/sdks/client/swift#hooks"
},
"Logging": {
"status": "❌",
"status": "✅",
"path": "/docs/reference/sdks/client/swift#logging"
},
"Domains": {
Expand Down