Skip to content

Commit 742a116

Browse files
authored
chore: update client js docs (#307)
* chore: update client js docs Signed-off-by: Mark Phelps <209477+markphelps@users.noreply.github.com> * chore: update self-hosted links Signed-off-by: Mark Phelps <209477+markphelps@users.noreply.github.com> * chore: one more missing reference Signed-off-by: Mark Phelps <209477+markphelps@users.noreply.github.com> --------- Signed-off-by: Mark Phelps <209477+markphelps@users.noreply.github.com>
1 parent 4e31123 commit 742a116

File tree

11 files changed

+24
-22
lines changed

11 files changed

+24
-22
lines changed

changelog/overview.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,12 @@ mode: "wide"
66

77
<Update label="March 2025">
88

9+
## Consolidated JavaScript Client-Side SDK
10+
11+
The JavaScript browser and Node.js SDKs have been consolidated into a single package.
12+
13+
See the [Integration docs](/integration/client) for more information.
14+
915
## Model Context Protocol (MCP)
1016

1117
Flipt now supports the [Model Context Protocol (MCP)](/tooling/model-context-protocol) which allows AI assistants and LLMs to directly interact with your feature flags, segments, and evaluations through a standardized interface.

cloud/guides/production.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Before you move to production, you need to have the following:
1414
1. An active Flipt Cloud account. If you don't have an account yet, [request access here](https://flipt.cloud).
1515
2. An active GitHub account. If you don't have an account yet, [sign up on GitHub](https://github.com).
1616
3. A configured Flipt environment in Flipt Cloud. If you don't have an environment yet, [follow the getting started guide](/cloud/guides/getting-started).
17-
4. Deployed Flipt instances in your infrastructure. If you don't have Flipt instances yet, [deploy Flipt Open Source](https://docs.flipt.io/self-hosted/overview).
17+
4. Deployed Flipt instances in your infrastructure. If you don't have Flipt instances yet, [deploy Flipt Open Source](/installation/overview).
1818

1919
## Create an API Key
2020

configuration/overview.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ Environment variables **MUST** have `FLIPT_` prefix and be in `UPPER_SNAKE_CASE`
9696

9797
<Note>
9898
Using environment variables to override defaults is especially helpful when
99-
running with Docker as described in the [Docker](/self-hosted/docker)
99+
running with Docker as described in the [Docker](/installation/docker)
100100
documentation.
101101
</Note>
102102

docs.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -426,6 +426,10 @@
426426
"source": "/experimental/filesystem-backends",
427427
"destination": "/configuration/storage"
428428
},
429+
{
430+
"source": "/self-hosted",
431+
"destination": "/installation"
432+
},
429433
{
430434
"source": "/self-hosted/overview",
431435
"destination": "/installation/overview"

guides/migration/launchdarkly/flipt.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ brew install flipt-io/brew/flipt
5252

5353
</CodeGroup>
5454

55-
For more details, see our [installation documentation](/self-hosted/overview).
55+
For more details, see our [installation documentation](/installation/overview).
5656

5757
## Migrate State from LaunchDarkly to Flipt
5858

installation/overview.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ brew install flipt-io/brew/flipt
3232

3333
For more details on each installation method, see the sections below.
3434

35-
- [Docker](/self-hosted/docker)
36-
- [Kubernetes](/self-hosted/kubernetes)
35+
- [Docker](/installation/docker)
36+
- [Kubernetes](/installation/kubernetes)
3737
- [Homebrew](#homebrew)
3838
- [Binary](#binary)
3939

integration/client.mdx

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -16,20 +16,12 @@ Flipt provides a number of client-side SDKs to help you integrate with Flipt in
1616

1717
<CardGroup cols={2}>
1818
<Card
19-
title="Node"
20-
href="https://github.com/flipt-io/flipt-client-sdks/tree/main/flipt-client-node"
21-
icon="node"
22-
color="#68a063"
23-
>
24-
Evaluate flags client-side in your Node applications
25-
</Card>
26-
<Card
27-
title="Browser"
28-
href="https://github.com/flipt-io/flipt-client-sdks/tree/main/flipt-client-browser"
19+
title="JavaScript"
20+
href="https://github.com/flipt-io/flipt-client-sdks/tree/main/flipt-client-js"
2921
icon="js"
3022
color="#f7e018"
3123
>
32-
Evaluate flags client-side in your browser-based applications
24+
Evaluate flags client-side in your Node.js or browser-based applications
3325
</Card>
3426
<Card
3527
title="React"

integration/overview.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: This document describes how to integrate Flipt in your existing app
44
---
55

66
<Info>
7-
To learn how to install and run Flipt, see the [Self-Hosted](/self-hosted)
7+
To learn how to install and run Flipt, see the [Installation](/installation)
88
documentation.
99
</Info>
1010

introduction.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Own your feature data, backed by Git.
2222
## Setup
2323

2424
Before getting started, make sure the Flipt server is up and running on your
25-
host on your chosen ports. See [Self-Hosted](/self-hosted) for more.
25+
host on your chosen ports. See [Installation](/installation) for more.
2626

2727
<CodeGroup>
2828

operations/deployment.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Details on various ways to deploy Flipt.
44
---
55

66
Flipt is built and delivered as a single standalone binary.
7-
Head to the [Self Hosted](/self-hosted/overview) section for more details.
7+
Head to the [Installation](/installation/overview) section for more details.
88

99
Running Flipt with the default configuration is a great way to get to grips with using it.
1010
However, the default settings have some limitations which might make it impractical in a production environment.
@@ -118,9 +118,9 @@ Read more about the [gRPC Health Checking Protocol](https://grpc.io/docs/guides/
118118

119119
## Kubernetes
120120

121-
Flipt already supports running as a [Docker container](/self-hosted/docker), so the lift to run within a Kubernetes environment proves to be quite simple.
121+
Flipt already supports running as a [Docker container](/installation/docker), so the lift to run within a Kubernetes environment proves to be quite simple.
122122

123-
The easiest way to get started is to use our official [Helm chart](/self-hosted/kubernetes). The chart provisions a Kubernetes Deployment of Flipt along with a Kubernetes Service.
123+
The easiest way to get started is to use our official [Helm chart](/installation/kubernetes). The chart provisions a Kubernetes Deployment of Flipt along with a Kubernetes Service.
124124

125125
If you are already familiar with Kubernetes, you can get started by using the `flipt:latest` image (or pin to a specific version).
126126

usecases/cloudnative.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ CloudNative means different things to different people. We define CloudNative as
2020

2121
Flipt is mainly distributed as a container image. While it is a single binary and can run easily on bare metal, most users choose to deploy Flipt to a container orchestration platform such as Kubernetes.
2222

23-
To deploy Flipt to Kubernetes, use our Helm chart as described in our [Kubernetes](/self-hosted/kubernetes) documentation.
23+
To deploy Flipt to Kubernetes, use our Helm chart as described in our [Kubernetes](/installation/kubernetes) documentation.
2424

2525
Flipt also integrates directly with Kubernetes service account tokens for authentication. This allows services deployed into the same Kubernetes cluster as Flipt to automatically gain authenticated access to the Flipt API without additional management of static client tokens.
2626

0 commit comments

Comments
 (0)