Skip to content

Commit 5f49bd5

Browse files
committed
Update OpenFeature providers docs
1 parent a0233c5 commit 5f49bd5

File tree

5 files changed

+19
-19
lines changed

5 files changed

+19
-19
lines changed

website/docs/sdk-reference/openfeature/angular.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,15 +24,15 @@ npm i @openfeature/angular-sdk @openfeature/config-cat-web-provider
2424
### 2. Initialize the Angular SDK
2525

2626
The `ConfigCatWebProvider.create()` function takes the SDK key and an optional `options` argument containing additional
27-
configuration options for the underlying [ConfigCat client](../../js#creating-the-configcat-client):
27+
configuration options for the underlying [ConfigCat client](../../js/browser/#creating-the-configcat-client):
2828

2929
* For applications using modules:
3030

3131
```ts
3232
import { NgModule } from '@angular/core';
3333
import { BooleanFeatureFlagDirective, type EvaluationContext, OpenFeatureModule } from '@openfeature/angular-sdk';
3434
import { ConfigCatWebProvider } from '@openfeature/config-cat-web-provider';
35-
import { createConsoleLogger, LogLevel } from 'configcat-js-ssr';
35+
import { createConsoleLogger, LogLevel } from '@configcat/sdk';
3636

3737
const configCatProvider = ConfigCatWebProvider.create('#YOUR-SDK-KEY#', {
3838
// Specify options for the underlying ConfigCat client
@@ -75,7 +75,7 @@ configuration options for the underlying [ConfigCat client](../../js#creating-th
7575
import { type ApplicationConfig, importProvidersFrom } from '@angular/core';
7676
import { type EvaluationContext, OpenFeatureModule } from '@openfeature/angular-sdk';
7777
import { ConfigCatWebProvider } from '@openfeature/config-cat-web-provider';
78-
import { createConsoleLogger, LogLevel } from 'configcat-js-ssr';
78+
import { createConsoleLogger, LogLevel } from '@configcat/sdk';
7979

8080
const configCatProvider = ConfigCatWebProvider.create('#YOUR-SDK-KEY#', {
8181
// Specify options for the underlying ConfigCat client
@@ -128,7 +128,7 @@ in the OpenFeature specification is a container for arbitrary contextual data th
128128
flag evaluation.
129129

130130
You can find [here](./js.mdx#evaluation-context) how the ConfigCat provider translates these evaluation contexts to
131-
ConfigCat [User Objects](../../js/#user-object).
131+
ConfigCat [User Objects](../../js/browser/#user-object).
132132

133133
## Advanced features
134134

website/docs/sdk-reference/openfeature/js.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,12 @@ npm i @openfeature/config-cat-web-provider
1919

2020
### 2. Initialize the provider
2121

22-
The `ConfigCatWebProvider.create()` function takes the SDK key and an optional `options` argument containing additional configuration options for the [ConfigCat JavaScript SDK](../../js/#creating-the-configcat-client):
22+
The `ConfigCatWebProvider.create()` function takes the SDK key and an optional `options` argument containing additional configuration options for the [ConfigCat Browser (JavaScript) SDK](../../js/browser/#creating-the-configcat-client):
2323

2424
```js
2525
import { OpenFeature } from "@openfeature/web-sdk";
2626
import { ConfigCatWebProvider } from '@openfeature/config-cat-web-provider';
27-
import { createConsoleLogger, LogLevel } from "configcat-js-ssr";
27+
import { createConsoleLogger, LogLevel } from "@configcat/sdk";
2828

2929
// Build options for the ConfigCat SDK.
3030
const options = {
@@ -40,7 +40,7 @@ await OpenFeature.setProviderAndWait(ConfigCatWebProvider.create('#YOUR-SDK-KEY#
4040
const client = OpenFeature.getClient();
4141
```
4242

43-
For more information about all the configuration options, see the [JavaScript SDK documentation](../../js/#creating-the-configcat-client).
43+
For more information about all the configuration options, see the [Browser (JavaScript) SDK documentation](../../js/browser/#creating-the-configcat-client).
4444

4545
### 3. Evaluate your feature flag
4646

@@ -64,7 +64,7 @@ await OpenFeature.clearProviders();
6464
## Evaluation Context
6565

6666
An <a href="https://openfeature.dev/docs/reference/concepts/evaluation-context" target="_blank">evaluation context</a> in the OpenFeature specification is a container for arbitrary contextual data that can be used as a basis for feature flag evaluation.
67-
The ConfigCat provider translates these evaluation contexts to ConfigCat [User Objects](../../js/#user-object).
67+
The ConfigCat provider translates these evaluation contexts to ConfigCat [User Objects](../../js/browser/#user-object).
6868

6969
The following table shows how the different context attributes are mapped to User Object attributes.
7070

website/docs/sdk-reference/openfeature/nestjs.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,15 +23,15 @@ npm i @openfeature/nestjs-sdk @openfeature/config-cat-provider
2323

2424
### 2. Initialize the NestJS SDK
2525

26-
The `ConfigCatProvider.create()` function takes the SDK key, the desired [polling mode](../../node#polling-modes)
26+
The `ConfigCatProvider.create()` function takes the SDK key, the desired [polling mode](../../js/node#polling-modes)
2727
(Auto Polling is recommended for this kind of application) and an optional `options` argument containing additional
28-
configuration options for the underlying [ConfigCat client](../../node#creating-the-configcat-client):
28+
configuration options for the underlying [ConfigCat client](../../js/node/#creating-the-configcat-client):
2929

3030
```ts
3131
import { Module } from '@nestjs/common';
3232
import { OpenFeatureModule } from '@openfeature/nestjs-sdk';
3333
import { ConfigCatProvider } from '@openfeature/config-cat-provider';
34-
import { createConsoleLogger, LogLevel, PollingMode } from 'configcat-js-ssr';
34+
import { createConsoleLogger, LogLevel, PollingMode } from '@configcat/sdk';
3535
import { FeatureFlagService } from './_services/feature-flag.service';
3636

3737
const configCatProvider = ConfigCatProvider.create('#YOUR-SDK-KEY#', PollingMode.AutoPoll, {
@@ -105,7 +105,7 @@ in the OpenFeature specification is a container for arbitrary contextual data th
105105
flag evaluation.
106106

107107
You can find [here](./node.mdx#evaluation-context) how the ConfigCat provider translates these evaluation contexts to
108-
ConfigCat [User Objects](../../node/#user-object).
108+
ConfigCat [User Objects](../../js/node/#user-object).
109109

110110
## Advanced features
111111

website/docs/sdk-reference/openfeature/node.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,12 @@ npm i @openfeature/config-cat-provider
1919

2020
### 2. Initialize the provider
2121

22-
The `ConfigCatProvider.create()` function takes the SDK key and an optional `options` argument containing additional configuration options for the [ConfigCat Node.js SDK](../../node/#creating-the-configcat-client):
22+
The `ConfigCatProvider.create()` function takes the SDK key and an optional `options` argument containing additional configuration options for the [ConfigCat Node.js SDK](../../js/node/#creating-the-configcat-client):
2323

2424
```js
2525
import { OpenFeature } from "@openfeature/server-sdk";
2626
import { ConfigCatProvider } from '@openfeature/config-cat-provider';
27-
import { createConsoleLogger, LogLevel, PollingMode } from "configcat-node";
27+
import { createConsoleLogger, LogLevel, PollingMode } from "@configcat/sdk";
2828

2929
// Build options for the ConfigCat SDK.
3030
const options = {
@@ -40,7 +40,7 @@ await OpenFeature.setProviderAndWait(ConfigCatProvider.create('#YOUR-SDK-KEY#',
4040
const client = OpenFeature.getClient();
4141
```
4242

43-
For more information about all the configuration options, see the [Node.js SDK documentation](../../node/#creating-the-configcat-client).
43+
For more information about all the configuration options, see the [Node.js SDK documentation](../../js/node/#creating-the-configcat-client).
4444

4545
### 3. Evaluate your feature flag
4646

@@ -64,7 +64,7 @@ await OpenFeature.clearProviders();
6464
## Evaluation Context
6565

6666
An <a href="https://openfeature.dev/docs/reference/concepts/evaluation-context" target="_blank">evaluation context</a> in the OpenFeature specification is a container for arbitrary contextual data that can be used as a basis for feature flag evaluation.
67-
The ConfigCat provider translates these evaluation contexts to ConfigCat [User Objects](../../node/#user-object).
67+
The ConfigCat provider translates these evaluation contexts to ConfigCat [User Objects](../../js/node/#user-object).
6868

6969
The following table shows how the different context attributes are mapped to User Object attributes.
7070

website/docs/sdk-reference/openfeature/react.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,12 @@ npm i @openfeature/react-sdk @openfeature/config-cat-web-provider
2424
### 2. Initialize the React SDK
2525

2626
The `ConfigCatWebProvider.create()` function takes the SDK key and an optional `options` argument containing additional
27-
configuration options for the underlying [ConfigCat client](../../js#creating-the-configcat-client):
27+
configuration options for the underlying [ConfigCat client](../../js/browser/#creating-the-configcat-client):
2828

2929
```jsx
3030
import { OpenFeature, OpenFeatureProvider } from '@openfeature/react-sdk';
3131
import { ConfigCatWebProvider } from '@openfeature/config-cat-web-provider';
32-
import { createConsoleLogger, LogLevel } from 'configcat-js-ssr';
32+
import { createConsoleLogger, LogLevel } from '@configcat/sdk';
3333

3434
const configCatProvider = ConfigCatWebProvider.create('#YOUR-SDK-KEY#', {
3535
// Specify options for the underlying ConfigCat client
@@ -85,7 +85,7 @@ in the OpenFeature specification is a container for arbitrary contextual data th
8585
flag evaluation.
8686

8787
You can find [here](./js.mdx#evaluation-context) how the ConfigCat provider translates these evaluation contexts to
88-
ConfigCat [User Objects](../../js/#user-object).
88+
ConfigCat [User Objects](../../js/browser/#user-object).
8989

9090
## Advanced features
9191

0 commit comments

Comments
 (0)