Skip to content

Add feature flag docs#9127

Open
aapeliv wants to merge 3 commits into
developfrom
docs/feature-flags
Open

Add feature flag docs#9127
aapeliv wants to merge 3 commits into
developfrom
docs/feature-flags

Conversation

@aapeliv

@aapeliv aapeliv commented Jun 16, 2026

Copy link
Copy Markdown
Member

No description provided.

@CouchersBot

CouchersBot commented Jun 16, 2026

Copy link
Copy Markdown
Member

Mobile

Install the Dev Tool (iOS via TestFlight, iOS Simulator, or Android .apk) here.

Scan the QR with your phone camera, or tap Open in Dev Tool on the device, to open this branch in the installed Dev Tool dev client.

    iOS         Android    
    QR to open the iOS build         QR to open the Android build    
    Open in Dev Tool         Open in Dev Tool    
Deep links

iOS

couchers-devtool://expo-development-client/?url=https%3A%2F%2F49a2277e--ota.preview.couchershq.org%2Fios%2Fmanifest

Android

couchers-devtool://expo-development-client/?url=https%3A%2F%2F49a2277e--ota.preview.couchershq.org%2Fandroid%2Fmanifest

Web (Vercel)

View the Vercel web preview for this branch.

Backend

Schema Schema diff Sample emails

Other

Protos Backend coverage Web coverage

@nabramow

Copy link
Copy Markdown
Member

@aapeliv This is a great start! One thing that would be super helpful is to add examples of the flags in use for frontend and backend to the doc. Maybe we could copy/paste some existing code blocks where the different types of flags are being used?

@nabramow

Copy link
Copy Markdown
Member

When do I use useFeatureValue and useFeatureIsOn and what's the difference between them?

@nabramow

Copy link
Copy Markdown
Member

Can you add some info for how to make a feature across frontend and backend visible on dev and staging but not prod?

@nabramow

Copy link
Copy Markdown
Member

Maybe some info about how to use this in the dev flow, i.e. do we need to manually switch the feature flags on when we code to see the feature while it's in progress?

Comment thread docs/feature-flags.md

The local backend does not pull the feature flags from the server, instead it resolves them from the override file in `feature-flags.dev.json`. You should set a value here that makes sense for devs developing locally (e.g. enable experimental features), and you can use it for local debug/testing temporary overrides (but don't commit this).

TODO: there is currently no such mechanism in the frontend; you can just manually modify the place where you check the flags.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's move this right to the top so it's obvious no frontend for now?

Comment thread docs/feature-flags.md

## Setting the value of a feature flag to a non-default value

To set the value of a feature flag to a non-default value for everyone for a given environment, follow this process:

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's not super clear to me what this means and when we would want to do it?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants