Skip to content

chore: update sdk readmes #1331

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 #1331

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
11 changes: 7 additions & 4 deletions docs/reference/other-technologies/cli.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ The OpenFeature CLI provides the following commands:
| Command | Description |
|---------|-------------|
| `init` | Initialize a new flag manifest |
| `manifest` | Manage flag manifest files (add, list) |
| `manifest` | Manage flag manifest files (add, list, delete) |
| `compare` | Compare two flag manifests |
| `generate` | Generate strongly typed flag accessors |
| `pull` | Fetch flags from remote sources |
Expand All @@ -129,7 +129,7 @@ See [here](https://github.com/open-feature/cli/blob/main/docs/commands/openfeatu

### `manifest`

Manage flag manifest files with subcommands for adding and listing flags.
Manage flag manifest files with subcommands for adding, listing, and deleting flags.

```bash
# Add a new flag interactively
Expand All @@ -146,11 +146,15 @@ openfeature manifest add welcome-message \

# List all flags in the manifest
openfeature manifest list

# Delete a flag from the manifest
openfeature manifest delete old-feature
```

The manifest command provides:
- **add**: Add new flags to your manifest file
- **list**: Display all flags with their configuration
- **delete**: Remove flags from your manifest file

See [here](https://github.com/open-feature/cli/blob/main/docs/commands/openfeature_manifest.md) for all available options.

Expand Down Expand Up @@ -195,15 +199,14 @@ openfeature generate typescript --output ./src/flags

| Language | Description |
|----------|-------------|
| `typescript` | TypeScript flag accessors |
| `javascript` | JavaScript flag accessors |
| `react` | React hooks for feature flags |
| `go` | Go flag accessors |
| `csharp` | C# flag accessors |
| `java` | Java flag accessors |
| `python` | Python flag accessors |
| `nestjs` | NestJS flag accessors |
| `nodejs` | Node.js flag accessors |
| `angular` | Angular flag accessors |

See [here](https://github.com/open-feature/cli/blob/main/docs/commands/openfeature_generate.md) for all available options.

Expand Down
10 changes: 5 additions & 5 deletions 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 Fri Jan 23 2026 08:12:20 GMT+0000 (Coordinated Universal Time)
Last updated at Fri Feb 06 2026 08:20:07 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/kotlin-sdk/releases/tag/v0.7.0">
<img alt="Release" src="https://img.shields.io/static/v1?label=release&message=v0.7.0&color=blue&style=for-the-badge" />
<a href="https://github.com/open-feature/kotlin-sdk/releases/tag/v0.7.1">
<img alt="Release" src="https://img.shields.io/static/v1?label=release&message=v0.7.1&color=blue&style=for-the-badge" />
</a>

<br/>
Expand Down Expand Up @@ -67,7 +67,7 @@ Installation is preferred via Maven Central.

```kotlin
dependencies {
api("dev.openfeature:kotlin-sdk:0.7.0")
api("dev.openfeature:kotlin-sdk:0.7.1")
}
```

Expand All @@ -77,7 +77,7 @@ dependencies {
kotlin {
sourceSets {
commonMain.dependencies {
api("dev.openfeature:kotlin-sdk:0.7.0")
api("dev.openfeature:kotlin-sdk:0.7.1")
}
}
}
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 Fri Jan 23 2026 08:12:20 GMT+0000 (Coordinated Universal Time)
Last updated at Fri Feb 06 2026 08:20:07 GMT+0000 (Coordinated Universal Time)
-->
import MCPInstall from '@site/src/partials/mcp-install';

Expand Down
13 changes: 8 additions & 5 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 Fri Jan 23 2026 08:12:20 GMT+0000 (Coordinated Universal Time)
Last updated at Fri Feb 06 2026 08:20:07 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-v0.0.20">
<img alt="Release" src="https://img.shields.io/static/v1?label=release&message=v0.0.20&color=blue&style=for-the-badge" />
<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>

<br/>
Expand Down Expand Up @@ -414,13 +414,16 @@ export class AppModule {}

Angular's lifecycle can result in flags being evaluated multiple times as a user interacts with a page.
If you are using an OpenFeature hook for telemetry, this can result in inflated evaluation metrics.
The [OpenFeature debounce hook](https://github.com/open-feature/js-sdk-contrib/tree/main/libs/hooks/debounce) can help to reduce the amount of redundant evaluations reported to your observability platform by limiting the frequency at which evaluation metrics are reported.
The [OpenFeature debounce hook](https://github.com/open-feature/js-sdk-contrib/tree/main/libs/hooks/debounce) can help
to reduce the amount of redundant evaluations reported to your observability platform by limiting the frequency at which
evaluation metrics are reported.

## FAQ and troubleshooting

> I can import things form the `@openfeature/angular-sdk`, `@openfeature/web-sdk`, and `@openfeature/core`; which should I use?

The `@openfeature/angular-sdk` re-exports everything from its peers (`@openfeature/web-sdk` and `@openfeature/core`), and adds the Angular-specific features.
The `@openfeature/angular-sdk` re-exports everything from its peers (`@openfeature/web-sdk` and `@openfeature/core`),
and adds the Angular-specific features.
You can import everything from the `@openfeature/angular-sdk` directly.
Avoid importing anything from `@openfeature/web-sdk` or `@openfeature/core`.

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 Fri Jan 23 2026 08:12:20 GMT+0000 (Coordinated Universal Time)
Last updated at Fri Feb 06 2026 08:20:07 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 Fri Jan 23 2026 08:12:20 GMT+0000 (Coordinated Universal Time)
Last updated at Fri Feb 06 2026 08:20:07 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/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 Fri Jan 23 2026 08:12:20 GMT+0000 (Coordinated Universal Time)
Last updated at Fri Feb 06 2026 08:20:07 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 Fri Jan 23 2026 08:12:19 GMT+0000 (Coordinated Universal Time)
Last updated at Fri Feb 06 2026 08:20:07 GMT+0000 (Coordinated Universal Time)
-->
import MCPInstall from '@site/src/partials/mcp-install';

Expand Down
4 changes: 2 additions & 2 deletions 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 Fri Jan 23 2026 08:12:19 GMT+0000 (Coordinated Universal Time)
Last updated at Fri Feb 06 2026 08:20:07 GMT+0000 (Coordinated Universal Time)
-->
import MCPInstall from '@site/src/partials/mcp-install';

Expand Down Expand Up @@ -151,7 +151,7 @@ evalCtx := openfeature.NewEvaluationContext(
"company": "Initech",
},
)
boolValue, err := client.BooleanValue("boolFlag", false, evalCtx)
boolValue, err := client.BooleanValue(context.TODO(), "boolFlag", false, evalCtx)
```

### Hooks
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 Fri Jan 23 2026 08:12:19 GMT+0000 (Coordinated Universal Time)
Last updated at Fri Feb 06 2026 08:20:07 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/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 Fri Jan 23 2026 08:12:19 GMT+0000 (Coordinated Universal Time)
Last updated at Fri Feb 06 2026 08:20:07 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 Fri Jan 23 2026 08:12:19 GMT+0000 (Coordinated Universal Time)
Last updated at Fri Feb 06 2026 08:20:07 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 Fri Jan 23 2026 08:12:19 GMT+0000 (Coordinated Universal Time)
Last updated at Fri Feb 06 2026 08:20:07 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 Fri Jan 23 2026 08:12:19 GMT+0000 (Coordinated Universal Time)
Last updated at Fri Feb 06 2026 08:20:07 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 Fri Jan 23 2026 08:12:20 GMT+0000 (Coordinated Universal Time)
Last updated at Fri Feb 06 2026 08:20:07 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 Fri Jan 23 2026 08:12:21 GMT+0000 (Coordinated Universal Time)
Last updated at Fri Feb 06 2026 08:20:07 GMT+0000 (Coordinated Universal Time)
-->

<p align="center" class="github-badges">
Expand Down
4 changes: 2 additions & 2 deletions src/datasets/sdks/sdk-compatibility.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -420,8 +420,8 @@
"path": "/docs/reference/sdks/client/kotlin",
"category": "Client",
"release": {
"href": "https://github.com/open-feature/kotlin-sdk/releases/tag/v0.7.0",
"version": "0.7.0",
"href": "https://github.com/open-feature/kotlin-sdk/releases/tag/v0.7.1",
"version": "0.7.1",
"stable": false
},
"spec": {
Expand Down