Skip to content

chore: update client js docs #307

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Mar 30, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions changelog/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@ mode: "wide"

<Update label="March 2025">

## Consolidated JavaScript Client-Side SDK

The JavaScript browser and Node.js SDKs have been consolidated into a single package.

See the [Integration docs](/integration/client) for more information.

## Model Context Protocol (MCP)

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.
Expand Down
2 changes: 1 addition & 1 deletion cloud/guides/production.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Before you move to production, you need to have the following:
1. An active Flipt Cloud account. If you don't have an account yet, [request access here](https://flipt.cloud).
2. An active GitHub account. If you don't have an account yet, [sign up on GitHub](https://github.com).
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).
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).
4. Deployed Flipt instances in your infrastructure. If you don't have Flipt instances yet, [deploy Flipt Open Source](/installation/overview).

## Create an API Key

Expand Down
2 changes: 1 addition & 1 deletion configuration/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ Environment variables **MUST** have `FLIPT_` prefix and be in `UPPER_SNAKE_CASE`

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

Expand Down
4 changes: 4 additions & 0 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -426,6 +426,10 @@
"source": "/experimental/filesystem-backends",
"destination": "/configuration/storage"
},
{
"source": "/self-hosted",
"destination": "/installation"
},
{
"source": "/self-hosted/overview",
"destination": "/installation/overview"
Expand Down
2 changes: 1 addition & 1 deletion guides/migration/launchdarkly/flipt.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ brew install flipt-io/brew/flipt

</CodeGroup>

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

## Migrate State from LaunchDarkly to Flipt

Expand Down
4 changes: 2 additions & 2 deletions installation/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ brew install flipt-io/brew/flipt

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

- [Docker](/self-hosted/docker)
- [Kubernetes](/self-hosted/kubernetes)
- [Docker](/installation/docker)
- [Kubernetes](/installation/kubernetes)
- [Homebrew](#homebrew)
- [Binary](#binary)

Expand Down
14 changes: 3 additions & 11 deletions integration/client.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,20 +16,12 @@ Flipt provides a number of client-side SDKs to help you integrate with Flipt in

<CardGroup cols={2}>
<Card
title="Node"
href="https://github.com/flipt-io/flipt-client-sdks/tree/main/flipt-client-node"
icon="node"
color="#68a063"
>
Evaluate flags client-side in your Node applications
</Card>
<Card
title="Browser"
href="https://github.com/flipt-io/flipt-client-sdks/tree/main/flipt-client-browser"
title="JavaScript"
href="https://github.com/flipt-io/flipt-client-sdks/tree/main/flipt-client-js"
icon="js"
color="#f7e018"
>
Evaluate flags client-side in your browser-based applications
Evaluate flags client-side in your Node.js or browser-based applications
</Card>
<Card
title="React"
Expand Down
2 changes: 1 addition & 1 deletion integration/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: This document describes how to integrate Flipt in your existing app
---

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

Expand Down
2 changes: 1 addition & 1 deletion introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Own your feature data, backed by Git.
## Setup

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

<CodeGroup>

Expand Down
6 changes: 3 additions & 3 deletions operations/deployment.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: Details on various ways to deploy Flipt.
---

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

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

## Kubernetes

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.
Flipt already supports running as a [Docker container](/installation/docker), so the lift to run within a Kubernetes environment proves to be quite simple.

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.
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.

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

Expand Down
2 changes: 1 addition & 1 deletion usecases/cloudnative.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ CloudNative means different things to different people. We define CloudNative as

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.

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

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.

Expand Down