* docs: standardize documentation writing style
* docs: apply brand tone and style fixes
* docs: refine brand tone and writing style
* Revert changelog.mdx changes
The changelog is generated content and shouldn't be rewritten by the
brand tone and writing style pass.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
* Update ai/model-context-protocol.mdx
* Update ai/model-context-protocol.mdx
---------
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com>
* docs: improve SEO title and descriptions for custom domain and Vercel pages
* Apply suggestion from @ethanpalm
* Apply suggestion from @ethanpalm
---------
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
* docs: update custom domain setup for new dashboard flow
Reflect the new custom domain UI: hosting mode selector (domain/subdomain
vs subpath), traffic routing options (Mintlify-managed vs proxy-only),
arbitrary base paths with reserved-path list, and base path changes that
redeploy with rollback on failure. Replace references to the removed
Host at /docs toggle in the Vercel and reverse proxy guides.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
* copy edit
* update images
* docs: update subpath proxy guides for dashboard base paths
Custom subpaths no longer require documentation files to live in a
directory matching the subpath. The base path set in the dashboard is
applied at build time, so the custom subpath reverse proxy setup now
uses the same routing configuration as /docs with the path substituted.
Add dashboard base path setup steps to the Vercel, Cloudflare Worker,
and Route 53/CloudFront guides.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
* 💅
* add plan gate
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
* update vercel generator
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
* remove gate
* remove gate
* Fix review findings: shared subpath setup snippet, generalize /docs framing, clarify Host header and script guidance
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
* Align hosting mode and traffic routing labels with dashboard UI, update screenshot alt text
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
* Fix root-only special file routing: path-preserving nginx destinations, restore sitemap/robots/mcp rewrites, sanitize generator input
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
* Add apex domain DNS provider requirements
Apex domains get the same CNAME instruction as subdomains, but a CNAME
at the apex requires provider support for CNAME flattening or ALIAS
records. Document the requirement and supported providers, and link to
it from the hosting mode section.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
* Correct special-file routing to base-path destinations per live verification, remove stale toggle images, generalize propagation snippet
Verified against mintlify.mintlify.site: all special files (sitemap.xml,
robots.txt, mcp, skill.md, llms.txt) serve under the base path and 404 at
root, so root-mapping rewrites are reverted and optional root routes now
proxy to base-path destinations. Broken links in es/fr/zh from image
deletion resolve via post-merge translation automation.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
* remove outdated images
* Update dashboard instructions for Host at toggle UI (mint #8979)
The hosting mode selector and traffic routing options were replaced with
a Host at toggle and inline base path input; routing is now inferred from
DNS. Verified against mint origin/main commit 6fb20b1789.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
* 💅
---------
Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
* docs: remove inaccurate lazy loading example from React components page
The deferred-mount example added in #6133 claimed to improve initial page
load, but all MDX component code (including imported snippets) is compiled
into the page and evaluated at hydration regardless of whether a component
mounts. Replace the example with an accurate code-splitting constraint and
an honest lazy loading consideration.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
* Apply suggestion from @ethanpalm
* 💅
---------
Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
* fix: reduce Vale false positives via vocab and config updates
- Make English-word vocab entries case-insensitive so sentence-start
capitalization and normal prose usage stop flagging (agents, rest,
cursor, setup, endpoints, etc.)
- Add vocab entries for filenames and code identifiers that appear in
frontmatter and JSX contexts (docs.json, llms.txt, CLAUDE.md, etc.)
- Ignore openapi frontmatter lines, filenames, JSX attributes, email
addresses, and internal link targets via TokenIgnores
- Skip inline code scope and indented code fences
- Add Headings exceptions for proper nouns (Claude Code, GitHub
Actions, Route 53, GA4, etc.)
- Disable linting for the all-code vercel-json-generator snippet
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
* fix: resolve all Vale warnings and errors across docs
Content fixes:
- Reword sentences using 'will', first person, spaced em dashes,
'e.g.', Latin abbreviations, and hyphenated adverbs
- Sentence-case headings that started with dotted filenames
- Backtick literal API values instead of bolding them
- Move periods inside quotation marks
- Fix Oxford comma rule misfires by restructuring sentences
False-positive suppression:
- Vale toggles around example user questions, keyboard shortcut keys
(Cmd+I), UI labels, and code samples in JSX contexts that Vale
misparses
- Exclude vale toggle comments from the brace Token/BlockIgnores so
in-document commands actually reach Vale (the greedy brace pattern
was also silently swallowing large regions; now lazy)
- Vocab entries for code identifiers (internal_id, handleSubmit, etc.)
- Per-file rule disables for component docs with dotted JSX names and
files where link-target linting ignores in-document toggles
Result: vale --minAlertLevel warning is clean repo-wide; only
suggestion-level items (Passive, Semicolons, Acronyms) remain.
mint broken-links passes.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
* fix: correct WordList rule instead of degrading prose
- Restore sentence-start "Email" in advanced-support; the rule now
only flags hyphenated e-mail/E-mail forms
- Restore the idiom "above all else"; the above->preceding swap now
exempts "above all"
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
* fix: restore deliberate prose flagged by blunt rules
- Restore spatial 'above the navbar' / 'above a page title' in
custom-scripts; the above->preceding swap now exempts 'above
the/a/an'
- Restore the '= ...' in the react-components named-export example
(the ellipsis is inside inline code) with an Ellipses toggle
- Restore SLA phrasing 'will use commercially reasonable efforts'
with a Will toggle
- Restore the quoted developer question in the GEO guide intro with a
FirstPerson toggle, matching the file's other example questions
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
* fix: remove WordList swaps that flag legitimate English
- Drop tablet->device and firewalls->firewall rules; both words are
correct in ordinary prose
- Narrow touch->tap to UI-instruction phrasing (touch the/a) so
'keep in touch' and 'touch devices' stop flagging
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
* fix: reposition vale toggles to wrap whole blocks
Toggle comments placed between list items split the lists (restarting
ol numbering in deployments) and comments flush against tables risked
breaking GFM table parsing. Wrap entire lists/tables with blank-line
separation instead. Verified rendering with mint dev: single ol with
two items, tables intact, no comments in visible DOM.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
* refactor: prune accept.txt to load-bearing entries
Empirically removed 166 vocab entries (575 -> 409) whose removal
causes no Vale flags across all 908 English pages: dictionary words
that never needed listing (agents, setup, endpoints, webhooks, yaml),
lowercase entries the speller already accepts, and filename entries
made redundant by inline vale toggles.
Kept every case-enforcing entry (API, JSON, GitHub, ...) so casing
policy is unchanged, plus entries that double as capitalization
exceptions for headings (mcp, md, auth, cursor, txt).
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
* Update ai/mintlify-mcp.mdx
* Update api/agent/v2/create-agent-job.mdx
* chore: alphabetize Headings exceptions and accept.txt
Case-insensitive sort, ignoring the (?i) prefix; also drops a
duplicate Scala entry.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
* fix: re-apply OxfordComma rewrite lost in branch merge
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
* docs: resolve Vale suggestions batch 1 (acronyms, semicolons, passive voice)
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
* docs: resolve remaining Vale suggestions (passive voice batch 2)
Rewrite ~90 passive constructions to active voice across deploy,
guides, migration-services, and organize docs. Toggle the deliberate
passive examples in the style-and-tone guide ('by zombies' test).
Add axios/lodash vocab entries for a repositioned code example.
vale . is now fully clean: 0 errors, 0 warnings, 0 suggestions.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
---------
Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
* docs: update hosted docs domain to mintlify.site
* docs: complete mintlify.site migration across remaining pages
Updates 45 files that PR 6282 had originally changed but were
reverted by PR 6285 and not re-addressed in this PR:
- snippets/vercel-json-generator.mdx (all 4 locales): rewrite
destinations now use mintlify.site, consistent with deploy/vercel.mdx
- assistant/use.mdx: example deep-link URLs
- ai/skillmd.mdx: agent card subdomain reference
- guides/assistant-embed.mdx: docsURL code example
- guides/codex.mdx: MCP URL example
- deploy/authentication-setup.mdx: example Mintlify subdomain
- discovery-openapi.json: domain identifier URL descriptions (4 occurrences)
- integrations/privacy/osano.mdx: managed rule domain
- editor/branching-and-publishing.mdx: branch preview URL format
- customize/themes.mdx: theme demo site links
- guides/help-center.mdx: live example link
- zh/editor/collaborate.mdx: branch preview URL format
All changes mirrored across es, fr, and zh locales.
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
---------
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
* Document custom hostname setup for Cloudflare-proxied domains
TXT pre-validation cannot complete while a domain is proxied through
Cloudflare, even when the records resolve correctly. Add a section with
the setup order for proxied domains and link it from the warning.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
* Update customize/custom-domain.mdx
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
---------
Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
* clarify MCP returns MD
* Fix doc issues surfaced by user feedback
- Fix claude mcp add --header argument order: the flag must come after
the positional <name> and <url> args because --header is variadic and
otherwise consumes everything that follows it, causing the "missing
required argument 'name'" error users reported.
- Add tip to wrap iframes in Frame component to prevent overflow (user
suggestion on image-embeds page).
- Fix broken anchor link in quickstart CLI tab: /cli/install has no
#clone-your-repository section; replaced with inline git clone
instructions and a correct link to /deploy/github.
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
* Document wide-mode behavior for side panel
Wide mode hides the entire side panel (not just the TOC), including
Panel components and OpenAPI request/response examples. This was
undocumented and actively confused a user who couldn't understand why
their OpenAPI example panels disappeared on wide-mode pages.
- Fix the wide mode description in organize/pages.mdx (it previously
said only the TOC was hidden, but ContentSideLayout.tsx returns null
for wide/center/custom modes entirely)
- Add a Note to components/panel.mdx calling out that the side panel
is absent on wide, center, and custom pages
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
* Resolve user feedback: clarify path formats, load timing, and analytics config
- react-components: add Constraints section (hooks pre-injected, no npm, no default exports)
- posthog: fix default host from app.posthog.com to ph.mintlify.com (confirmed via source)
- plausible: add ParamField descriptions including server field explanation
- create/text: note that internal links require root-relative paths without file extensions
- create/image-embeds: clarify image paths are root-relative, relative paths unsupported
- create/redirects: show redirects as top-level field in full docs.json example
- customize/custom-scripts: note that custom JS runs after page is interactive, applies globally
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
* 💅
---------
Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
* docs: fix Vale warnings in files changed in the last week
* docs: mirror Vale fixes to es and fr translations
* Apply suggestion from @ethanpalm
* Apply suggestion from @ethanpalm
* Apply suggestions from code review
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
---------
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
* docs: boost search ranking for single-word title pages
Apply `boost: 3` to English pages whose H1 / frontmatter title is a single word (e.g. "Assistant", "Quickstart", "Cards"). Short titles tend to be canonical landing pages for a topic, so users searching the exact term should land on them first.
* docs: drop boost on websocket-playground stub to keep canonical Playground ranking
`api-playground/websocket-playground.mdx` is an auto-generated AsyncAPI stub with no body content but shares the title "Playground" with `api-playground/overview.mdx`. Boosting both equally diluted the canonical overview page in search for the query "playground". Drop the boost on the stub.
* Add new CSS selector attributes for tabs and topbar components
Generated-By: mintlify-agent
* Clarify CSS selector data attribute docs
- Add note that TabsBarItem uses a class selector (`.nav-tabs-item`) rather than a custom element name, and explain why
- Note that data-active does not apply to dropdown-style TabsBarItems
- Add intro sentence explaining the purpose of data-component-name selectors
- Note that PrimaryHeaderButton is Sequoia theme only
- Fix capitalization of TableOfContentsItem (deepest) description for consistency
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
* Add Mermaid data-component-name selectors to CSS reference
Documents mermaid-container (outer wrapper) and mermaid-controls-wrapper
(zoom/pan controls overlay) — both use data-component-name in the client
source and are distinct from the existing `mermaid` class selector which
targets only the inner SVG element.
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
* Update custom-scripts.mdx
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
* Replace internal React names with plain-English labels in data attributes
Labels like DropdownItem, MobileNavTabsBarItem, and MermaidContainer are
internal component names not meaningful to users writing CSS. Replaced with
descriptions of what each element is (e.g. "Active item in a nav dropdown").
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
---------
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
* Revert "Replace S3 URLs with relative paths for theme and hero images (#5051)"
This reverts commit 43b3783e8c.
* fix: use GitHub raw URLs for image assets
Replace S3 bucket URLs with direct links to GitHub raw content for image assets. This provides a more consistent and reliable source for images used across the documentation pages.
mintlify[bot]