* 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: fix Vale warnings from PRs merged in the last week
* docs: mirror Vale style fixes into es/fr/zh translations
---------
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
Renames optimize/search-boost.mdx to optimize/search.mdx and
restructures it so search boost is one section alongside the new
"Maximum search results" setting from mint #7771. Updates inbound
links (changelog, pages.mdx, settings-reference.mdx) to deep-link
into the boost section, adds a redirect from the old path, and
includes light/dark screenshots of the new dashboard settings page.
Adds the `searchable: true` option to the Hidden pages guide as the
second way to expose hidden content to search, sitemap, AI context,
and search engines. Cross-references it from the SEO sitemap section.
Use `seo.indexing: "all"` for site-wide opt-in, or `searchable: true`
on a specific hidden tab or group when only that subtree should be
discoverable.
* Standardize style: 'Click' to 'Select' for Mintlify UI; split long sentences
Generated-By: mintlify-agent
* Revert 'select' back to 'click' for UI interactions
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
* Fix select→click for UI elements across docs
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>
* 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.
* Document the search boost feature
Add an optimize/search-boost page explaining how to bias in-product
search ranking by setting a numeric boost multiplier in page frontmatter
or on a docs.json navigation group, including inheritance rules and
de-prioritization with sub-1 values. Cross-reference from the boost
frontmatter ResponseField in organize/pages and add the new page to the
Optimize navigation group.
* Document boost in the docs.json schema reference
Add a navigation.groups[].boost subsection under navigation.groups in
the docs.json schema reference page, with a link out to the topic page.
* Apply boost: 2 to Get started and boost: 0.5 to Changelog
Bias in-product search ranking toward onboarding content and away from
the changelog. Doubles as a live test of the search boost feature.
* Clarify that pages not in docs.json navigation are not indexed
Generated-By: mintlify-agent
* Add warning about pages not in nav being treated as hidden
Generated-By: mintlify-agent
* copyedit
---------
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
* Improve SEO descriptions across 47 pages
Curated descriptions from two bot-generated PRs (#3908, #3949),
selecting the best approach for each page:
- Added missing title and description frontmatter to 10 API reference pages
- Benefit-focused descriptions for integration pages (not implementation-heavy)
- Accurate REST-aligned titles for API endpoints (Export, List, Trigger, etc.)
- Expanded short descriptions to 50–160 character range throughout
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
* copyedit
* Update custom-domain.mdx
* Fix analytics API page titles to match spec summaries
"Export" was inaccurate — spec uses "Get" for both endpoints.
Also updated descriptions to use "Retrieve" for consistency.
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
---------
Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
Ethan Palm