Skip to content

Commit 5ac3dee

Browse files
committed
docs: adjust naming conventions and style
1 parent 4e8eca3 commit 5ac3dee

10 files changed

Lines changed: 39 additions & 44 deletions

File tree

docs/docs/flagsmith-integration/CLI.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ FLAGS
3333
-o, --output=<value> [default: ./flagsmith.json] The file path output
3434

3535
DESCRIPTION
36-
Retrieve flagsmith features from the Flagsmith API and output them to a file.
36+
Retrieve flagsmith feature flags from the Flagsmith API and output them to a file.
3737

3838
EXAMPLES
3939
$ FLAGSMITH_ENVIRONMENT=x flagsmith get

docs/docs/flagsmith-integration/client-side-sdks/android.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ flagsmith.getFeatureFlags { result ->
8181
}
8282
```
8383

84-
### Get Flags for an identity
84+
### Get Flags for an Identity
8585

8686
To get feature flags for a specific identity:
8787

docs/docs/flagsmith-integration/client-side-sdks/flutter.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Flagsmith Flutter SDK
33
sidebar_label: Flutter
4-
description: Manage your Feature Flags and Remote Config in your Flutter applications.
4+
description: Manage your Feature Flags and Remote Config in your Flutter Applications.
55
slug: /clients/flutter
66
---
77

@@ -146,7 +146,7 @@ bool isFeatureEnabled = flagsmithClient.hasCachedFeatureFlag('feature');
146146

147147
### Identifying users
148148

149-
To check if a feature exists for an Identity:
149+
To check if a feature exists for an identity:
150150

151151
```dart
152152
final user = Identity(identifier: 'flagsmith_sample_user');
@@ -158,7 +158,7 @@ if (featureEnabled) {
158158
}
159159
```
160160

161-
To get the feature flag configuration value for an Identity:
161+
To get the feature flag configuration value for an identity:
162162

163163
```dart
164164
final myRemoteConfig = await flagsmithClient.getFeatureFlagValue('my_test_feature', user: user);
@@ -169,7 +169,7 @@ if (myRemoteConfig != null) {
169169
}
170170
```
171171

172-
To get the user traits for an Identity:
172+
To get the user traits for an identity:
173173

174174
```dart
175175
final userTraits = await flagsmithClient.getTraits(user)
@@ -180,7 +180,7 @@ if (userTraits != null && userTraits) {
180180
}
181181
```
182182

183-
To get the trait value for an Identity and specific Trait key:
183+
To get the trait value for an identity and specific trait key:
184184

185185
```dart
186186
final userTrait = await flagsmithClient.getTrait(user, 'cookies_key');
@@ -191,7 +191,7 @@ if (userTrait != null) {
191191
}
192192
```
193193

194-
Or get user traits for an Identity and specific Trait keys:
194+
Or get user traits for an identity and specific trait keys:
195195

196196
```dart
197197
final userTraits = await flagsmithClient.getTraits(user, keys: ['cookies_key', 'other_trait']);
@@ -202,7 +202,7 @@ if (userTraits != null) {
202202
}
203203
```
204204

205-
To update a user trait for an Identity:
205+
To update a user trait for an identity:
206206

207207
```dart
208208
final userTrait = await flagsmithClient.getTrait(user, 'cookies_key');

docs/docs/flagsmith-integration/client-side-sdks/javascript.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,13 @@
11
---
22
title: Flagsmith JavaScript SDK
33
sidebar_label: JavaScript
4-
description: Manage your Feature Flags and Remote Config in your JavaScript applications.
4+
description: Manage your Feature Flags and Remote Config in your JavaScript Applications.
55
slug: /clients/javascript
66
---
77

8-
This library can be used with pure JavaScript, React (and all other popular frameworks/libraries) and React Native
9-
projects. The source code for the client is available on [GitHub](https://github.com/flagsmith/flagsmith-js-client).
8+
This library can be used with pure JavaScript, React (and all other popular frameworks/libraries) and React Native projects. The source code for the client is available on [GitHub](https://github.com/flagsmith/flagsmith-js-client).
109

11-
Example applications for a variety of JavaScript frameworks such as React, Vue and Angular, as well as React Native, can
12-
be found here:
10+
Example applications for a variety of JavaScript frameworks such as React, Vue and Angular, as well as React Native, can be found here:
1311

1412
- [Flagsmith Framework Examples](https://github.com/Flagsmith/flagsmith-js-examples/tree/main)
1513

@@ -126,7 +124,7 @@ cli commands can be found [here](https://github.com/Flagsmith/flagsmith-cli).
126124
## Identifying users
127125

128126
Identifying users allows you to target specific users from the Flagsmith dashboard and configure features and traits.
129-
You can call this before or after you initialise the project, calling it after will re-fetch features from the API.
127+
You can call this before or after you initialise the project, calling it after will re-fetch feature flags from the API.
130128

131129
You can identify the users as part of initialising the client or after with the function `flagsmith.identify`.
132130

@@ -148,7 +146,7 @@ flagsmith.init({
148146

149147
const { isFromServer } = params; //determines if the update came from the server or local cached storage
150148

151-
//Set a trait against the Identity
149+
//Set a trait against the identity
152150
flagsmith.setTrait('favourite_colour', 'blue'); //This save the trait against the user, it can be queried with flagsmith.getTrait
153151

154152
//Check for a feature
@@ -196,7 +194,7 @@ flagsmith.init({
196194

197195
const { isFromServer } = params; //determines if the update came from the server or local cached storage
198196

199-
//Set a trait against the Identity
197+
//Set a trait against the identity
200198
flagsmith.setTrait('favourite_colour', 'blue'); //This save the trait against the user, it can be queried with flagsmith.getTrait
201199

202200
//Check for a feature
@@ -229,7 +227,7 @@ All function and property types can be seen
229227

230228
| Property | Description | Required | Default Value |
231229
| ------------------------------------------------------------------------------------------- | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | -------: | ----------------------------------------------------: |
232-
| `environmentID: string` | Defines which project environment you wish to get flags for. _example ACME Project - Staging._ | **YES** | null |
230+
| `environmentID: string` | Defines which project environment you wish to get flags for. _example ACME project - Staging._ | **YES** | null |
233231
| `onChange?: (previousFlags:IFlags, params:IRetrieveInfo, loadingState:LoadingState)=> void` | Your callback function for when the flags are retrieved `(previousFlags,{isFromServer:true/false,flagsChanged: true/false, traitsChanged:true/false})=>{...}` | **YES** | null |
234232
| `onError?: (res:{message:string}) => void` | Callback function on failure to retrieve flags. `(error)=>{...}` | | null |
235233
| `realtime?:boolean` | Whether to listen for [Real Time Flag events](/advanced-use/real-time-flags) | | false |

docs/docs/flagsmith-integration/flagsmith-api-overview/admin-api/code-examples.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Code Examples
33
sidebar_label: Code Examples
44
---
55

6-
Here is a simple example of how to use the Admin API with `curl` to create a new Environment within a Project.
6+
Here is a simple example of how to use the Admin API with `curl` to create a new environment within a project.
77

88
```bash
99
curl 'https://api.flagsmith.com/api/v1/environments/' \

docs/docs/flagsmith-integration/flagsmith-api-overview/flags-api/authentication.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ The Flags API uses a non-secret **Environment Key** for authentication. This key
99

1010
You can find the Environment Key for each of your environments in the Flagsmith dashboard.
1111

12-
1. Navigate to the Project you want to work with.
12+
1. Navigate to the project you want to work with.
1313
2. Go to the **Environments** tab.
1414
3. You will see a list of your environments, each with its own Client-side Environment Key.
1515

docs/docs/flagsmith-integration/flagsmith-api-overview/flags-api/code-examples.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,11 @@ curl 'https://edge.api.flagsmith.com/api/v1/flags/' \
1616

1717
### Get Flags for an Identified User
1818

19-
This command performs the entire SDK Identity workflow in a single call:
19+
This command performs the entire SDK identity workflow in a single call:
2020

21-
1. Lazily creates an Identity if it doesn't already exist.
22-
2. Sets or updates Traits for that Identity.
23-
3. Receives the flags for that Identity, including any segment or identity-specific overrides.
21+
1. Lazily creates an identity if it doesn't already exist.
22+
2. Sets or updates traits for that identity.
23+
3. Receives the flags for that identity, including any segment or identity-specific overrides.
2424

2525
```bash
2626
curl --request POST 'https://edge.api.flagsmith.com/api/v1/identities/' \

docs/docs/flagsmith-integration/integration-overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ sidebar_position: 10
66

77
Flagsmith is designed to be integrated into your applications in a variety of ways, depending on your architecture and requirements. This guide provides an overview of the different integration options available.
88

9-
## Deciding between Front-end and Back-end Flags
9+
## Deciding between Front-end and Back-end Feature Flags
1010

1111
One of the first decisions to make when integrating Flagsmith is whether to evaluate flags on the front-end (client-side) or back-end (server-side).
1212

docs/docs/flagsmith-integration/openfeature.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,11 @@ sidebar_position: 50
66

77
# OpenFeature
88

9-
[OpenFeature](https://openfeature.dev/) is an open standard for feature flag management, created to support a robust
10-
feature flag ecosystem using cloud native technologies. OpenFeature provides a unified API and SDK, and a
11-
developer-first, cloud-native implementation, with extensibility for open source and commercial offerings.
9+
[OpenFeature](https://openfeature.dev/) is an open standard for feature flag management, created to support a robust feature flag ecosystem using cloud native technologies. OpenFeature provides a unified API and SDK, and a developer-first, cloud-native implementation, with extensibility for open source and commercial offerings.
1210

13-
Flagsmith is proud to contribute to this initiative, and is a governance board member of this CNCF project. Our goal,
14-
and that of OpenFeature, is to recommend using OpenFeature as the default SDK interface for Flagsmith projects.
11+
Flagsmith is proud to contribute to this initiative, and is a governance board member of this CNCF project. Our goal, and that of OpenFeature, is to recommend using OpenFeature as the default SDK interface for Flagsmith projects.
1512

16-
OpenFeature is being actively worked on; we encourage anyone interested Feature Flags and Open Source to get involved!
13+
OpenFeature is being actively worked on; we encourage anyone interested in feature flags and open source to get involved!
1714

1815
## Flagsmith OpenFeature Providers
1916

docs/docs/flagsmith-integration/server-side.mdx

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -576,23 +576,23 @@ secret_button_feature_value = Flagsmith.Client.get_feature_value(flags, "secret_
576576

577577
### When running in [Remote Evaluation mode](/clients#remote-evaluation)
578578

579-
- When requesting Flags for an Identity, all the Traits defined in the SDK will automatically be persisted against the
580-
Identity within the Flagsmith API.
581-
- Traits passed to the SDK will be added to all the other previously persisted Traits associated with that Identity.
582-
- This full set of Traits are then used to evaluate the Flag values for the Identity.
579+
- When requesting flags for an identity, all the traits defined in the SDK will automatically be persisted against the
580+
identity within the Flagsmith API.
581+
- Traits passed to the SDK will be added to all the other previously persisted traits associated with that identity.
582+
- This full set of traits are then used to evaluate the flag values for the identity.
583583
- This all happens in a single request/response.
584584

585585
### When running in [Local Evaluation mode](/clients#local-evaluation)
586586

587-
- _Only_ the Traits provided to the SDK at runtime will be used. Local Evaluation mode, by design, does not make any
588-
network requests to the Flagsmith API when evaluating Flags for an Identity.
587+
- _Only_ the traits provided to the SDK at runtime will be used. Local Evaluation mode, by design, does not make any
588+
network requests to the Flagsmith API when evaluating flags for an identity.
589589
- When running in Local Evaluation Mode, the SDK requests the
590590
[Environment Document](/clients#the-environment-document) from the Flagsmith API. This contains all the
591-
information required to make Flag Evaluations, but it does _not_ contain any Trait data.
591+
information required to make flag evaluations, but it does _not_ contain any trait data.
592592

593593
## Managing Default Flags
594594

595-
Default Flags are configured by passing in a function that is called when a Flag cannot be found or if the network
595+
Default flags are configured by passing in a function that is called when a flag cannot be found or if the network
596596
request to the API fails when retrieving flags.
597597

598598
<Tabs groupId="language" queryString>
@@ -1004,9 +1004,9 @@ The Server Side SDKS share the same network behaviour across the different langu
10041004

10051005
### Remote Evaluation Mode Network Behaviour
10061006

1007-
- A blocking network request is made every time you make a call to get an Environment Flags. In Python, for example,
1007+
- A blocking network request is made every time you make a call to get an environment flags. In Python, for example,
10081008
`flagsmith.get_environment_flags()` will trigger this request.
1009-
- A blocking network request is made every time you make a call to get an Identities Flags. In Python, for example,
1009+
- A blocking network request is made every time you make a call to get an identities flags. In Python, for example,
10101010
`flagsmith.get_identity_flags(identifier=identifier, traits=traits)` will trigger this request.
10111011

10121012
### Local Evaluation Mode Network Behaviour
@@ -1019,12 +1019,12 @@ To use Local Evaluation mode, you must use a Server Side key.
10191019
10201020
:::
10211021
1022-
- When the SDK is initialised, it will make an asynchronous network request to retrieve details about the Environment.
1023-
- Every 60 seconds (by default), it will repeat this aysnchronous request to ensure that the Environment information it
1022+
- When the SDK is initialised, it will make an asynchronous network request to retrieve details about the environment.
1023+
- Every 60 seconds (by default), it will repeat this aysnchronous request to ensure that the environment information it
10241024
has is up to date.
10251025
10261026
To achieve Local Evaluation, in most languages, the SDK spawns a separate thread (or equivalent) to poll the API for
1027-
changes to the Environment. In certain languages, you may be required to terminate this thread before cleaning up the
1027+
changes to the environment. In certain languages, you may be required to terminate this thread before cleaning up the
10281028
instance of the Flagsmith client. Languages in which this is necessary are provided below.
10291029
10301030
<Tabs groupId="language" queryString>

0 commit comments

Comments
 (0)