Skip to content

docs: Experimentation v2 — draft for team review#7316

Draft
talissoncosta wants to merge 6 commits intomainfrom
docs/experimentation-v2
Draft

docs: Experimentation v2 — draft for team review#7316
talissoncosta wants to merge 6 commits intomainfrom
docs/experimentation-v2

Conversation

@talissoncosta
Copy link
Copy Markdown
Contributor

@talissoncosta talissoncosta commented Apr 22, 2026

Thanks for submitting a PR! Please check the boxes below:

  • I have read the Contributing Guide.
  • I have added information to docs/ if required so people know about the feature.
  • I have filled in the "Changes" section below.
  • I have filled in the "How did you test this code" section below.

Changes

Closes #7344. Part of the #7275 epic.

Contributes to the Experimentation v2 effort.

Draft for team alignment — opened early so we can discuss flow, terminology, and scope before the backend work starts.

Replaces the existing "bring your own analytics" A/B testing guide (docs/docs/experimentation-ab-testing.md) with a v2 proposal based on the prototype in #7195. Three flows are covered:

  1. Connecting a data warehouse — one-time org-level setup that enables metric computation
  2. Creating an experiment — the 5-step wizard, starting from the Experiments list as the entry point
  3. Reading experiment results — stat cards, recommendation callout, metrics comparison table, trend chart

Known open questions for the team

  • Single vs. multi metric. Asaph mentioned v1 will ship with a single metric. Current draft reflects the prototype (primary / secondary / guardrail roles) — we should decide whether to simplify the Select Metrics step and drop the role system for v1. Flagged inline.
  • "Test Connection" button. Draft documents the prototype's Test + Connect two-button pattern. If we drop Test for v1 simplicity, the Step 3 warehouse flow shortens significantly.
  • Terminology. Draft uses "hypothesis", "primary / secondary / guardrail", "control / treatment", "lift" — all industry-standard A/B vocabulary, new to Flagsmith. "Bucketed by identity" aligns with the existing experimentation-ab-testing.md which already uses bucketing terminology. Worth confirming we're happy to commit to this vocabulary in public docs.
  • Experiment Results scope. Included per team decision — let me know if this should land in a follow-up doc instead.

What's not in scope

  • Metrics library / creating metrics (descoped for v1)
  • Post-launch management (pause, stop, re-launch)
  • Public API / SDK changes

How did you test this code?

  • Docs build: please run cd docs && npm install && make serve to verify the page renders
  • Image placeholders: all 14 images are marked as TODO in the markdown. They reference /img/experimentation/*.png. Screenshots will be captured from the prototype and added before merge.
  • Prototype cross-reference: every flow in this doc maps to a live surface in [WIP] feat: Experiments V2 wizard + Warehouse Connection Settings UI #7195. See that PR's description for demo URLs if you want to click through while reviewing.

Image capture plan

Screenshots to capture (most critical first):

  • hero-results-dashboard.png
  • warehouse-connected.png
  • experiments-list.png
  • wizard-details.png + wizard-review-launch.png
  • results-comparison-table.png

Remaining 8 images can land before merge — full list in the draft markdown.

What kind of feedback is most useful

  • Flow order within each path
  • Terminology — anything that feels off for Flagsmith's voice
  • Scope cuts / additions for v1
  • Conceptual gaps a docs reader would trip on

Replaces the existing "bring your own analytics" A/B testing guide with
a v2 proposal covering three flows: data warehouse connection, create
experiment wizard, and reading results. All images are placeholders —
screenshots will land before merge.

Opening as a draft PR to align on flow, terminology, and scope before
the backend work starts. Complements the prototype at #7195 where the
same flows are live to click through.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@vercel
Copy link
Copy Markdown

vercel Bot commented Apr 22, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment Apr 23, 2026 4:04pm
2 Skipped Deployments
Project Deployment Actions Updated (UTC)
flagsmith-frontend-preview Ignored Ignored Preview Apr 23, 2026 4:04pm
flagsmith-frontend-staging Ignored Ignored Preview Apr 23, 2026 4:04pm

Request Review

@github-actions github-actions Bot added the docs Documentation updates label Apr 22, 2026
…URLs

Docusaurus' MDX compiler rejects markdown images whose paths don't resolve
to an existing file, failing the Link Check Docs job. Screenshots haven't
been captured yet, so swap every placeholder to a text callout with the
target filename preserved. Flips back to real images once screenshots land.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Warehouse setup is conceptually a third-party integration, not an
Experimentation concept — sits naturally alongside Amplitude, Segment,
and the other analytics destinations. Experimentation page keeps a brief
pointer and links across.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Flips the top-5 placeholders to real images: experiments list, wizard
step 1 (Details), wizard step 6 (Review & Launch), full results dashboard,
and the warehouse connected state. Remaining 9 placeholders stay as text
callouts pending capture.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
The two-button Test + Connect pattern is deferred to a later iteration
per product planning. V1 ships with a single Connect action that
validates on save, which removes one step, one screenshot, and the
"stale test result" warning from the documented flow.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
talissoncosta added a commit that referenced this pull request Apr 23, 2026
Per product planning, the two-button Test + Connect pattern is deferred
to a later iteration. v1 ships with a single Connect action that
validates credentials on save. Removes the testStatus state, runTest
helper, inline test-result banner, the stale-test-result clearing logic,
and the associated SCSS rules + keyframes.

Keeps the prototype aligned with the Experimentation docs draft (#7316).

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Flips the remaining wizard, results, and warehouse config-form
placeholders to real image references. Two placeholders remain for
screenshots still to be captured: the hero image on the Experimentation
page and the Organisation Integrations list shot.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation updates

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs: Data Warehouse setup + Experimentation v2 guides

1 participant