Skip to content

Document Bayesian model as closed beta, fix broken #bayesian anchor - #198

Open
russell-loube-mixpanel wants to merge 2 commits into
mainfrom
docs/bayesian-closed-beta
Open

Document Bayesian model as closed beta, fix broken #bayesian anchor#198
russell-loube-mixpanel wants to merge 2 commits into
mainfrom
docs/bayesian-closed-beta

Conversation

@russell-loube-mixpanel

Copy link
Copy Markdown
Contributor

What

Two things, both in docs/experiments.mdx:

  1. Tells customers the Bayesian experiment model is in closed beta.
  2. Fixes three broken #bayesian anchor links.

Follow-up to #159, which documented the Bayesian model but didn't mention its availability.

Closed beta

The model isn't enabled for all projects, so the docs shouldn't read as though anyone can pick it. Three changes, one callout plus two signposts at the points where a customer is actually choosing a model:

  • Bayesian section — a <Note>: closed beta, not enabled for all projects, how to request access, behavior may change before GA. Uses the <Note> + bolded-lead pattern from docs/mcp.mdx and docs/session-replay.mdx.
  • Step 5: Confirm other Default Configurations — "Bayesian if your project is in the closed beta." This is where someone reads about the model picker and would otherwise go hunting for an option they can't see.
  • References → Experiment Model Types — labeled "Bayesian (closed beta)" so the comparison list doesn't imply parity with Sequential and Frequentist.

Anchor fix

How do you read statistical significance? links to #bayesian, and that link is dead. The cause is the heading, not the link:

Mintlify only emits heading ids down to h4. ##### Bayesian is an h5, so it renders with no id, and every link to #bayesian goes nowhere. Confirmed against the live page — id="how-mixpanel-calculates-results" (h4) is present; id="bayesian" and id="frequentist-and-sequential" (both h5) are absent.

Fixed with an explicit <span id="bayesian" />, matching the workaround already in docs/tracking-methods/sdks/swift.mdx:84 and docs/tracking-methods/sdks/javascript.mdx:217. One anchor repairs all three call sites.

I checked all 19 in-page anchor links on this page; #bayesian was the only broken one.

Two things worth a reviewer's attention

1. How customers request access. I wrote "reach out to your account team," the phrasing this page already uses for gated Experiments features. If the beta has a specific intake — a form, a named PM, an allowlist request — that sentence should name it instead.

2. Whether the picker is hidden or visible-but-disabled. The callout says "if you don't see it in the Experiment Model type picker," which assumes non-beta projects don't see the option. If it renders greyed out instead, that phrasing needs changing.

Follow-up not done here

The <span> anchor fixes the symptom but leaves the h5 trap in place — Frequentist and Sequential still has no id, and any future link to it will break the same way. The structural fix is promoting both model subsections h5 → h4, which flattens the nesting under "How Mixpanel Calculates Results" that #159 introduced. Left alone deliberately; happy to do it if preferred.

Testing

No local Mintlify build in this environment, so the MDX is unrendered — worth previewing. The anchor behavior was verified against the deployed site rather than a local build.

🤖 Generated with Claude Code

The Bayesian model is in closed beta and not enabled for all projects.
Adds a closed-beta callout to the Bayesian section, plus signposts at
the two places a customer picks a model type (Step 5 config defaults
and the Experiment Model Types reference).

Also fixes three broken #bayesian anchor links. Mintlify only emits
heading ids down to h4; "##### Bayesian" is an h5, so it renders with
no id and every link to #bayesian was dead. Adds an explicit
<span id="bayesian" /> anchor, matching the workaround already used in
docs/tracking-methods/sdks/swift.mdx.

Co-Authored-By: Claude <noreply@anthropic.com>
@mintlify

mintlify Bot commented Aug 27, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
mixpanel-docs 🟢 Ready View Preview Aug 27, 2026, 8:53 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@greptile-apps

greptile-apps Bot commented Aug 27, 2026

Copy link
Copy Markdown
Contributor

Confidence Score: 5/5

The PR appears safe to merge.

No blocking failure remains.

Important Files Changed

Filename Overview
docs/experiments.mdx Clearly scopes Bayesian model availability and restores the documented in-page navigation target.

Reviews (2): Last reviewed commit: "Merge branch 'main' into docs/bayesian-c..." | Re-trigger Greptile

Comment thread docs/experiments.mdx

This example shows why larger sample sizes are crucial—with only 10 users per group, even a 10-point difference in conversion rate isn't statistically significant.

<span id="bayesian" />

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Perhaps using #### for Bayesian is a cleaner fix than adding a custom span

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

Labels

None yet

2 participants