docs: address documentation gaps from three-year client support audit#721
Open
bertilhatt wants to merge 2 commits intomainfrom
Open
docs: address documentation gaps from three-year client support audit#721bertilhatt wants to merge 2 commits intomainfrom
bertilhatt wants to merge 2 commits intomainfrom
Conversation
✅ Deploy Preview for eppo-data-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Adds callouts, warnings, and new sections across 25 documentation pages to address gaps identified during a systematic three-year audit of ~75 client Slack channels. Changes include: - Diagnostic query approximation callout (excludes CUPED++, winsorization, mixed-assignment) - Run Log as source of truth when Diagnostics is insufficient - Backfill triage: Eppo pipeline failed (no backfill) vs upstream data fixed (full refresh) - Entry point replaces assignment timestamp; filter-only alternative via Assignment SQL - SSC does not account for CUPED++ (qualify run-time estimates) - Self-service warehouse table cleanup (Admin → Pipeline Update Schedules) - SA migration checklist for warehouse connection pages - ConfigurationStore environment isolation warning (iOS/Android) - Holdout allocation band fragmentation and date immutability - Flag archival irreversibility and key reuse - JSON variation type coercion (int → double) - Layer parameter lock on active layers - Winsorization truncation (not discard) and Diagnostic exclusion - Assignment logging required fields and experiment field inclusion - Global Lift unique entity metric non-additivity caveat - Interaction effects limited to Simple metrics - Sequential test three-trigger readiness model - CDN stale-if-error 429 gap - SSO SP-initiated only constraint Made-with: Cursor
ba2d088 to
cc61a50
Compare
…nup nav - Lookback window: 24h → 2 days (matches DEFAULT_INC_LOOKBACK_PERIOD_DAYS) - Ready-for-review: three independent paths, not all-three-required; document min-requirements gate and traffic-imbalance blocker - Flag archival: note that keys can be reused after archival - Warehouse cleanup: Admin → Settings → Experiment Schedule Settings Made-with: Cursor
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation
I used Claude to go through Slack channel with clients and identify patterns of responses and product information mentioned there. I also used it to match with our docs, compare and identify topics that were not covered in the docs. It suggested this (very long) PR.
Summary
Adds callouts, warnings, and new sections across 25 documentation pages to address gaps identified during a systematic three-year audit of ~75 client Slack channels (430+ findings documented in the internal playbook audit). Every change addresses a pattern where clients repeatedly needed information that wasn't in the public docs.
Changes are organized by client impact:
High priority (7 items — frequent questions, high confusion):
experimentcauses silent data lossMedium priority (11 items — recurring confusion):
stale-if-errordoes not cover 429 responsesLower priority (7 items):
3 lower-priority items were skipped as out of scope for this repo (billing model, API status field in Swagger, incident communication runbook).
Test plan
Made with Cursor