Documentation quality check: fix config keys, URLs, and gaps

[mintlify]

Summary

Quality review of the 64 English MDX pages changed in the last 24 hours found five pages with real gaps or incorrect instructions; this PR fixes them.

Changes

• integrations/analytics/overview.mdx
  • Gap: the setup snippet used "apiKey" for Hightouch, but the config schema and client require writeKey. Copying the snippet silently breaks the integration.
  • Fix: changed the key to writeKey (verified against the validation schema, the client analytics service, and the dedicated Hightouch page).
• search-index/connect.mdx
  • Gap: all manual config snippets pointed to https://index.mintlify.com while the CLI writes https://index.mintlify.com/mcp, so readers verifying or configuring manually hit a mismatch.
  • Fix: aligned every snippet (Claude Code, Cursor incl. deeplink, VS Code, Codex, OpenCode, Windsurf, Zed) to the /mcp endpoint the CLI uses.
• editor/publish.mdx
  • Gap: a note claimed switching branches prompts you to bring unpublished changes along; the dashboard only prompts on branch creation, and switching discards unsaved changes. This risked lost work.
  • Fix: scoped the prompt to branch creation, warned that switching loses unsaved changes, and linked to the branches guide.
• editor/agent.mdx
  • Gap: the page stated role requirements but never plan availability, so Starter-plan readers can't tell why there's no Ask agent button.
  • Fix: added a line that the editor agent is included on Pro and Enterprise plans and doesn't consume credits (verified against credits.mdx).
• components/view.mdx
  • Gap: the page never explained where the multi-view dropdown comes from; the title prop description implied it's configured elsewhere.
  • Fix: added that the dropdown is built automatically from View titles on the page (duplicates ignored, untitled views not rendered) and reworded the title prop description.

Also worth reviewing

Lower-severity gaps found but not fixed (cap of five pages per run):

• components/code-groups.mdx: Properties section omits the dropdown prop documented in prose.
• components/color.mdx: frontmatter promises click-to-copy but the body never mentions it.
• components/fields.mdx and components/responses.mdx: no pointer to Expandable for nested properties.
• dashboard/security-contact.mdx: doesn't say the setting is admin-only.
• editor/settings.mdx: intro scope labels ("Publishing") don't match any page heading.
• deploy/gitlab.mdx: mentions MR previews without linking /deploy/preview-deployments.
• integrations/analytics/segment.mdx: no link to the tracked events list.
• organize/settings-integrations.mdx: cookies fields lack a purpose description.
• ai/bring-your-own-model.mdx: "fixed set of models" and "reduced rate" are never quantified. Left as an open gap: the exact discount interacts with fixed action pricing in ways not verifiable from the docs alone.

---

Note

Low Risk
Documentation-only changes; they correct misleading setup and workflow text without touching application code.

Overview
Documentation fixes across English and localized (es, fr, zh) pages so setup instructions match product behavior and schemas.

Integrations & Index: Hightouch in the analytics overview now documents writeKey instead of apiKey, consistent with the Hightouch integration page. All Mintlify Index MCP examples (CLI, Cursor deeplink, VS Code, Codex, OpenCode, Windsurf, Zed) now use https://index.mintlify.com/mcp instead of the root URL.

Editor: The publish guide clarifies that unpublished-change prompts apply only when creating a branch; switching to an existing branch does not prompt and can lose unsaved work, with a link to the branches guide. Localized editor agent pages note the agent is on Pro and Enterprise and does not use credits.

View component: Docs state the multi-view dropdown is built from each View’s title on the page (duplicates ignored, untitled views not rendered), and the title property description no longer implies a separately configured dropdown.

^{Reviewed by Cursor Bugbot for commit 89eacfd. Bugbot is set up for automated code reviews on this repo. Configure here.}

[mintlify]

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

Project	Status	Preview	Updated
mintlify	🟢 Ready	View Preview	Sep 9, 2026, 10:19 AM