Skip to content

Commit d143fae

Browse files
chore: update SDK docs
Signed-off-by: Jonathan Norris <[email protected]>
1 parent ffcf7b0 commit d143fae

File tree

18 files changed

+31
-36
lines changed

18 files changed

+31
-36
lines changed

docs/reference/other-technologies/cli.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ EOL
8686
openfeature generate react
8787
```
8888

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

9191
3. View the generated code:
9292

@@ -115,7 +115,7 @@ openfeature init
115115
This command creates a `flags.json` file in your current directory with the proper schema reference.
116116
You can customize the manifest path using configuration options.
117117

118-
See [here](https://github.com/open-feature/cli/blob/docs-update-readme-for-website/docs/commands/openfeature_init.md) for all available options.
118+
See [here](https://github.com/open-feature/cli/blob/main/docs/commands/openfeature_init.md) for all available options.
119119

120120
### `generate`
121121

@@ -146,7 +146,7 @@ openfeature generate typescript --output ./src/flags
146146
| `nestjs` | NestJS flag accessors |
147147
| `nodejs` | Node.js flag accessors |
148148

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

151151
### `version`
152152

@@ -156,7 +156,7 @@ Print the version number of the OpenFeature CLI.
156156
openfeature version
157157
```
158158

159-
See [here](https://github.com/open-feature/cli/blob/docs-update-readme-for-website/docs/commands/openfeature_version.md) for all available options.
159+
See [here](https://github.com/open-feature/cli/blob/main/docs/commands/openfeature_version.md) for all available options.
160160

161161
## Flag Manifest
162162

docs/reference/other-technologies/ofrep.mdx

Lines changed: 10 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,7 @@ The **OpenFeature Remote Evaluation Protocol (OFREP)** is an API specification f
1212
- **Vendor Agnostic**: Connect to any OFREP-compliant flag management system without vendor-specific implementations
1313
- **Standardized**: Built on a common OpenAPI specification for consistent integration
1414
- **Flexible**: Works on both client-side and server-side applications
15-
- **Community Maintained**: Generic OFREP providers maintained by the OpenFeature community
16-
- **Simple Migration**: Switch between flag management systems without changing application code
15+
- **Community Maintained**: Generic OFREP providers maintained by the OpenFeature project
1716

1817
## How It Works
1918

@@ -39,13 +38,13 @@ OFREP supports both paradigms defined by OpenFeature:
3938
#### Server-Side (Dynamic Context)
4039

4140
- Evaluation happens by calling the OFREP API with context
42-
- No in-process evaluation inside OFREP providers, API request made on every evaluation.
43-
- Context changes frequently (per request, per user)
41+
- API request with evaluation context is made on every evaluation
42+
- Context per evaluation
4443

4544
#### Client-Side (Static Context)
4645

47-
- Evaluation happens locally with pre-fetched flag data
48-
- Provider reconciles state using the OFREP API when context changes
46+
- All flags are evaluated in one OFREP API call using a common static context
47+
- Then local flag evaluation happens against the cached static context
4948
- Context represents a single user or session
5049

5150
## Using OFREP
@@ -56,7 +55,7 @@ The OpenFeature community maintains OFREP providers for multiple languages. View
5655

5756
### Available Flag Management Systems
5857

59-
Many flag management systems support OFREP. View the complete list of [OFREP-compliant systems in the ecosystem](https://openfeature.dev/ecosystem/?instant_search%5BrefinementList%5D%5Btype%5D%5B0%5D=OFREP%20API).
58+
Several flag management systems support OFREP. View the complete list of [OFREP-compliant systems in the ecosystem](https://openfeature.dev/ecosystem/?instant_search%5BrefinementList%5D%5Btype%5D%5B0%5D=OFREP%20API).
6059

6160
## Implementing OFREP
6261

@@ -65,18 +64,14 @@ Many flag management systems support OFREP. View the complete list of [OFREP-com
6564
To create an OFREP provider for a new language:
6665

6766
1. Review the [server provider guideline](https://github.com/open-feature/protocol/blob/docs-update-readme-for-website/guideline/dynamic-context-provider.md) or [client provider guideline](https://github.com/open-feature/protocol/blob/docs-update-readme-for-website/guideline/static-context-provider.md)
68-
2. Implement the provider interface for your SDK
69-
3. Add HTTP client logic to call OFREP endpoints
70-
4. Handle error cases and response codes according to the specification
71-
5. Register your provider in the [OpenFeature ecosystem](https://github.com/open-feature/openfeature.dev/issues)
67+
2. Implement the provider for your SDK according to the guidelines
68+
3. Register your provider in the [OpenFeature ecosystem](https://github.com/open-feature/openfeature.dev/issues)
7269

7370
### For Flag Management System Developers
7471

7572
To make your flag management system OFREP-compliant:
7673

7774
1. Implement the [OFREP OpenAPI specification](https://github.com/open-feature/protocol/blob/docs-update-readme-for-website/service/openapi.yaml)
78-
2. Expose OFREP endpoints at `/ofrep/v1/evaluate/...`
79-
3. Support both bulk evaluation (for client-side) and single flag evaluation (for server-side)
80-
4. Test your implementation with existing OFREP providers
81-
5. Register your system in the [OpenFeature ecosystem](https://github.com/open-feature/openfeature.dev/issues)
75+
2. Test your implementation with existing OFREP providers
76+
3. Register your system in the [OpenFeature ecosystem](https://github.com/open-feature/openfeature.dev/issues)
8277

docs/reference/sdks/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 Fri Oct 24 2025 16:39:59 GMT-0400 (Eastern Daylight Time)
13+
Last updated at Mon Oct 27 2025 14:02:00 GMT-0400 (Eastern Daylight Time)
1414
-->
1515

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

docs/reference/sdks/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 Fri Oct 24 2025 16:39:59 GMT-0400 (Eastern Daylight Time)
13+
Last updated at Mon Oct 27 2025 14:02:00 GMT-0400 (Eastern Daylight Time)
1414
-->
1515

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

docs/reference/sdks/client/web/angular.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 Fri Oct 24 2025 16:39:59 GMT-0400 (Eastern Daylight Time)
13+
Last updated at Mon Oct 27 2025 14:02:00 GMT-0400 (Eastern Daylight Time)
1414
-->
1515

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

docs/reference/sdks/client/web/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 Fri Oct 24 2025 16:39:59 GMT-0400 (Eastern Daylight Time)
13+
Last updated at Mon Oct 27 2025 14:02:00 GMT-0400 (Eastern Daylight Time)
1414
-->
1515

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

docs/reference/sdks/client/web/react.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 Fri Oct 24 2025 16:39:59 GMT-0400 (Eastern Daylight Time)
13+
Last updated at Mon Oct 27 2025 14:02:00 GMT-0400 (Eastern Daylight Time)
1414
-->
1515

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

docs/reference/sdks/server/dart.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 dart-server-sdk.
99
Edits should be made here: https://github.com/open-feature/dart-server-sdk
1010
Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs
1111

12-
Last updated at Fri Oct 24 2025 16:39:59 GMT-0400 (Eastern Daylight Time)
12+
Last updated at Mon Oct 27 2025 14:02:00 GMT-0400 (Eastern Daylight Time)
1313
-->
1414

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

docs/reference/sdks/server/dotnet.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 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 Fri Oct 24 2025 16:39:58 GMT-0400 (Eastern Daylight Time)
13+
Last updated at Mon Oct 27 2025 14:01:59 GMT-0400 (Eastern Daylight Time)
1414
-->
1515

1616
[![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)

docs/reference/sdks/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 Fri Oct 24 2025 16:39:58 GMT-0400 (Eastern Daylight Time)
12+
Last updated at Mon Oct 27 2025 14:01:59 GMT-0400 (Eastern Daylight Time)
1313
-->
1414

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

0 commit comments

Comments
 (0)