Skip to content

Commit 3d47a4d

Browse files
docs: fix option names, defaults, typos, and outdated EdgeDB instructions
1 parent 2838d04 commit 3d47a4d

19 files changed

+25
-26
lines changed

docs/sdk/client-side-sdks/android/android-gettingstarted.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -119,8 +119,8 @@ The SDK exposes various initialization options which can be used by passing a `D
119119
| configCacheTTL | Long | 2592000000 | The maximum allowed age of a cached config in milliseconds, defaults to 30 days |
120120
| disableConfigCache | Boolean | false | Disable the use of cached configs |
121121
| disableRealtimeUpdates | Boolean | false | Disable Realtime Updates |
122-
| apiProxyURL | String | null | Allows the SDK to communicate with a proxy of DevCycle Client SDK API. |
123-
| eventsApiProxyURL | String | null | Allows the SDK to communicate with a proxy of DevCycle Events API. |
122+
| apiProxyUrl | String | null | Allows the SDK to communicate with a proxy of DevCycle Client SDK API. |
123+
| eventsApiProxyUrl | String | null | Allows the SDK to communicate with a proxy of DevCycle Events API. |
124124

125125
## Notifying when DevCycle features are available
126126

docs/sdk/client-side-sdks/android/android-usage.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -294,9 +294,9 @@ devcycleClient.flushEvents(new DevCycleCallback<String>() {
294294

295295
## EdgeDB
296296

297-
EdgeDB allows you to save user data to our EdgeDB storage so that you don't have to pass in all the user data every time you identify a user. Read more about [EdgeDB](/platform/feature-flags/targeting/edgedb).
297+
EdgeDB allows you to save user data to our EdgeDB storage so that you don't have to pass in all the user data every time you identify a user.
298298

299-
To get started, contact us at support@devcycle.com to enable EdgeDB for your project.
299+
To get started, enable EdgeDB on your project by following the guide [here](/platform/feature-flags/targeting/edgedb).
300300

301301
Once you have EdgeDB enabled in your project, pass in the enableEdgeDB option to turn on EdgeDB mode for the SDK:
302302

docs/sdk/client-side-sdks/flutter/flutter-usage.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -162,9 +162,8 @@ _devcycleClient.flushEvents(([error]) => {
162162
## EdgeDB
163163

164164
EdgeDB allows you to save user data to our EdgeDB storage so that you don't have to pass in all the user data every time you identify a user.
165-
Read more about [EdgeDB](/platform/feature-flags/targeting/edgedb).
166165

167-
To get started, contact us at support@devcycle.com to enable EdgeDB for your project.
166+
To get started, enable EdgeDB on your project by following the guide [here](/platform/feature-flags/targeting/edgedb).
168167

169168
Once you have EdgeDB enabled in your project, pass in the enableEdgeDB option to turn on EdgeDB mode for the SDK:
170169

docs/sdk/client-side-sdks/ios/ios-gettingstarted.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ The SDK exposes various initialization options which can be used by passing a `D
123123

124124
| Method | Parameter | Default | Description |
125125
| ---------------------------- | --------- | --------- | -------------------------------------------------------------------------------------------------------------- |
126-
| flushEventsIntervalMs | Int | 10000 | Controls the interval between flushing events to the DevCycle servers in milliseconds, defaults to 10 seconds. |
126+
| eventFlushIntervalMS | Int | 10000 | Controls the interval between flushing events to the DevCycle servers in milliseconds, defaults to 10 seconds. |
127127
| disableCustomEventLogging | Boolean | false | Disables logging of custom events generated by calling `.track()` method to DevCycle. |
128128
| disableAutomaticEventLogging | Boolean | false | Disables logging of SDK generated events (e.g. variableEvaluated, variableDefaulted) to DevCycle. |
129129
| logLevel | LogLevel | error | Set log level of the default logger. Defaults to `error` |

docs/sdk/client-side-sdks/javascript/javascript-gettingstarted.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,12 +33,12 @@ const devcycleClient = initializeDevCycle(
3333

3434
## Deferred Initialization
3535

36-
In many cases, user data is not available at the time of initialization. If the intialization call is made without a
36+
In many cases, user data is not available at the time of initialization. If the initialization call is made without a
3737
`user` object, then by default the SDK will be instantiated with an "anonymous" user and a configuration will be
3838
downloaded from DevCycle. The SDK makes a call to get the configuration for anonymous user and initializes.
3939

4040
If you would like to defer initialization of the SDK until your user data is available, you can pass the
41-
`deferInitialization` option to the `intializeDevCycle` method. This will cause the SDK to not fetch a configuration until the
41+
`deferInitialization` option to the `initializeDevCycle` method. This will cause the SDK to not fetch a configuration until the
4242
[`devcycleClient.identifyUser`](/sdk/client-side-sdks/javascript/javascript-usage#identifying-user) method is called with the user data.
4343
Until that config is retrieved, all calls
4444
to retrieve variable values will return their default values.

docs/sdk/client-side-sdks/javascript/javascript-usage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@ See [getVariables](https://docs.devcycle.com/bucketing-api/#tag/Bucketing-API/op
159159
This method is intended to be used for debugging and analytics purposes, _not_ as a method for retrieving the value of Variables to change code behaviour.
160160
For that purpose, we strongly recommend using the individual variable access method described in [Using Variable Values](#using-variable-values)
161161
Using this method instead will result in no evaluation events being tracked for individual variables, and will not allow the use
162-
of other DevCycle features such as [Feature Reach](/platform/feature-flags/variables-and-variations/feature-flag-reach.md), [Metrics](docs/platform/experimentation/creating-and-managing-metrics.md), [Code Usage detection](/integrations/github/feature-usage-action), and [Stale Feature detection](/platform/feature-flags/stale-feature-notifications.md).
162+
of other DevCycle features such as [Feature Reach](/platform/feature-flags/variables-and-variations/feature-flag-reach.md), [Metrics](/platform/experimentation/creating-and-managing-metrics.md), [Code Usage detection](/integrations/github/feature-usage-action), and [Stale Feature detection](/platform/feature-flags/stale-feature-notifications.md).
163163

164164
:::
165165

docs/sdk/client-side-sdks/react-native/react-native-usage.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ Events can be tracked by calling the `track` method provided by the client objec
150150
```js
151151
const event = {
152152
type: 'my_event_type', // this is required
153-
date: Date().now(),
153+
date: new Date(),
154154
target: 'my_target',
155155
value: 5,
156156
metaData: {
@@ -176,7 +176,7 @@ devcycleClient.flushEvents(() => {
176176

177177
EdgeDB allows you to save user data to our EdgeDB storage so that you don't have to pass in all the user data every time you identify a user.
178178

179-
To get started, contact us at support@devcycle.com to enable EdgeDB for your project.
179+
To get started, enable EdgeDB on your project by following the guide [here](/platform/feature-flags/targeting/edgedb).
180180

181181
Once you have EdgeDB enabled in your project, pass in the `enableEdgeDB` option to turn on EdgeDB mode for the SDK:
182182

docs/sdk/client-side-sdks/roku/roku-usage.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -108,9 +108,9 @@ m.devcycleClient.flushEvents()
108108

109109
## EdgeDB
110110

111-
EdgeDB allows you to save user data to our EdgeDB storage so that you don't have to pass in all the user data every time you identify a user. Read more about [EdgeDB](/platform/feature-flags/targeting/edgedb).
111+
EdgeDB allows you to save user data to our EdgeDB storage so that you don't have to pass in all the user data every time you identify a user.
112112

113-
To get started, contact us at support@devcycle.com to enable EdgeDB for your project.
113+
To get started, enable EdgeDB on your project by following the guide [here](/platform/feature-flags/targeting/edgedb).
114114

115115
Once you have EdgeDB enabled in your project, pass in the enableEdgeDB option to turn on EdgeDB mode for the SDK:
116116

docs/sdk/server-side-sdks/dotnet/dotnet-openfeature.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ var variableResult = await oFeatureClient.GetStringDetails(readOnlyVariable.Key,
106106

107107
### Required TargetingKey
108108

109-
For DevCycle SDK to work we require either a `targetingKey` or `user_id` to be set on the OpenFeature context.
109+
The DevCycle provider requires either a `targetingKey` or `user_id` to be set on the OpenFeature context.
110110
This is used to identify the user as the `user_id` for a `DevCycleUser` in DevCycle.
111111

112112
### Context properties to DevCycleUser

docs/sdk/server-side-sdks/go/go-openfeature.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ Use a Variable value by passing the Variable key, default value, and EvaluationC
9696

9797
### Required TargetingKey
9898

99-
For the DevCycle SDK to work we require either a `targetingKey` or `user_id` to be set on the OpenFeature context.
99+
The DevCycle provider requires either a `targetingKey` or `user_id` to be set on the OpenFeature context.
100100
This is used to identify the user as the `UserId` for a `devcycle.User` in DevCycle.
101101

102102
### Context properties to User

0 commit comments

Comments
 (0)