26 Commits

Author SHA1 Message Date
mintlify[bot] e2787cfd93 Apply brand tone and writing style fixes (#6893)
* 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>
2026-08-07 16:56:42 -07:00
Ethan Palm 0922398042 fix link to git settings 2026-07-13 16:08:00 -07:00
mintlify[bot] 31ea2c2af6 docs: remove Feedback add-ons unavailable troubleshooting section (#6515)
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
2026-07-12 16:33:59 -07:00
Ethan Palm 017d7c7377 Fix Vale warnings (#6378)
* 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>
2026-07-02 17:17:56 -07:00
mintlify[bot] bf64fd9d7e docs: fix spelling, grammar, and formatting issues across English docs (#6257)
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
2026-06-24 18:26:19 +00:00
Ethan Palm 6bb14aa061 docs: replace dashboard.mintlify.com with app.mintlify.com (#5990)
Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-05-26 15:42:09 -07:00
mintlify[bot] e0549a2f07 docs: align instructional copy with second-person style (#5986)
* docs: use second person for instructional recommendations

* Update ci.mdx

* Update ghes.mdx

---------

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
2026-05-26 15:40:55 -07:00
Patrick Foster 27b17b7db0 fix: remove tip to only give workflows access to docs repos (#5799) 2026-05-13 19:04:04 -07:00
mintlify[bot] f14cca3b52 Standardize style and tone across docs (#5652)
* 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>
2026-05-08 15:34:08 -07:00
mintlify[bot] 2731b04658 Fix style consistency issues across docs (#5694)
* Fix style consistency issues across docs

Generated-By: mintlify-agent

* 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>
2026-05-07 14:12:52 -07:00
mintlify[bot] 693dbc361f Fix Vale style warnings from PRs merged in the last week (#5690)
* Fix Vale style warnings across docs from past week of merges

Generated-By: mintlify-agent

* Apply suggestion from @ethanpalm

* Apply suggestion from @ethanpalm

* Apply suggestion from @ethanpalm

* 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>
2026-05-07 10:28:17 -07:00
skeptrune 9200586a3a Boost search ranking for single-word title pages (#5670)
* 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.
2026-05-05 10:30:58 -07:00
mintlify[bot] 11cf5370de Update GitHub docs for Git setup wizard (#5417)
* Update GitHub docs to reflect the new Git setup wizard

Generated-By: mintlify-agent

* add gitlab updates

* Update quickstart.mdx

* Update github.mdx

* caution

---------

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
2026-04-16 14:41:33 -07:00
mintlify[bot] f8e015ff62 Improve SEO descriptions across 177 pages (#4993)
* Improve SEO metadata: update descriptions to 130-155 chars across 177 pages

Generated-By: mintlify-agent

* Apply suggestion from @ethanpalm

* Apply suggestions from code review

Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>

* 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>
2026-03-31 16:12:58 -07:00
mintlify[bot] 67f6f22555 Remove Clone as Private/Public buttons from Git Settings docs (#3463)
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
2026-02-13 15:38:40 -08:00
Ethan Palm aba75bcebe Document feedback restrictions for private repos (#3191)
* Update optimize/feedback.mdx

Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>

* Update deploy/github.mdx

Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>

* Update deploy/github.mdx

* Update optimize/feedback.mdx

---------

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
2026-02-06 12:10:35 -08:00
mintlify[bot] 394004851f Update deploy/github.mdx (#2995)
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
2026-01-30 10:29:02 -08:00
Ethan Palm e175258025 Mintlify Docs Edits (#2514)
* Documentation edits made through Mintlify web editor

* Documentation edits made through Mintlify web editor
2025-12-28 21:49:24 -08:00
mintlify[bot] e1640e0b73 Update deploy/github.mdx (#2509)
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
2025-12-24 13:42:50 -05:00
mintlify[bot] 4c92b53528 Add documentation for cloning repo from mintlify-community (#2507)
* Update deploy/github.mdx

Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>

* Apply suggestion from @skeptrunedev

* Update deploy/github.mdx

Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>

* Update deploy/github.mdx

Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>

---------

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
Co-authored-by: skeptrune <nick@mintlify.com>
2025-12-24 13:12:40 -05:00
Ethan Palm 7c4f314298 Onboarding updates (#2336)
* add local preview page

* clarify when someone needs the GitHub app

* add local preview prereq

* add CLI prerequisites

* add more context on Git

* update details about GitHub App for mintlify-community repos

* update branch information

* simplify quickstart

* add links to local setup guide

* add local-setup to nav

* add local setup page

* 💅

* consistent naming for web editor

* make migrations title more connected to onboarding

* make "Get started" group more focused

* combine local setup into CLI page

* fix editor step

* link to CLI in quickstart next steps

* quickstart 💅

* github 💅

* remove preview-locally page

* guides 💅

* copyedits

* cli 💅

* remove passive voice
2025-12-16 15:19:32 -08:00
mintlify[bot] ed545fa56a Added GitHub Enterprise IP allowlist documentation (#1780)
* Update deploy/github.mdx

* Update deploy/github.mdx

---------

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
2025-11-14 15:38:20 -08:00
Ethan Palm 4c31f3683c SEO: add keywords to pages (#1775)
* ai/ keywords

* api/ keywords

* components/ keywords

* create/ keywords

* customize/ keywords

* api-playground/ keywords

* dashboard/ keywords

* deploy/ keywords

* guides/ keywords

* insights/ keywords

* integrations/ keywords

* optimize/ keywords

* organize/ keywords

* root/ keywords

* rm temp files
2025-11-14 14:08:24 -08:00
Ethan Palm 4b68a8e5ec Update descriptions for SEO (#1767)
* add global metatags

* set "indexing": "all"

* update AI group descriptions

* api-playground descriptions

* root level page descriptions

* component descriptions

* create descriptions

* customize descriptions

* dashboard descriptions

* deploy descriptions

* guides descriptions

* insights descriptions

* api-playground

* organize descriptions

* Integrations descriptions
2025-11-13 17:14:39 -08:00
Ian Steneker 28f8c329fa Improvements to Vale configuration page and GitHub App Installation (#1711)
* Add additional pieces to help with github app installation

* add examples of vale file structures to deploy/ci page

* Apply suggestions from code review

* clean up vale checks, clean up github.mdx

* configure expandable

* Update deploy/github.mdx

* use tip callout for recommendation

* active voice

* active voice

* remove `expandable` for short code blocks

* non destructive callouts shouldn't be warnings

---------

Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
2025-11-06 15:24:38 -08:00
Ethan Palm 654d533b90 Task based IA (#1353)
* implement task-based IA

* rearrange pages

* tag examples

* add cookbook example

* add a components menu

* rename cookbook to guides

* fix docs.json after adding translations

* prettier docs.json

* move content to Guides

* move GEO page to guides

* draft of ai-native page

* update body with info on reading/distributing

* copy edits

* 💅

* move guides above API reference

* remove CLI sidebarTitle

* update organization

* remove tags

* remove guides icons

* Update ai-native.mdx

* Update ai-native.mdx

* copyedits

* 💅

* even number of cards

* update discovering section

* remove components tab

* remove icons

* remove icon

* add group level icons

* update Get started group

* Update organize group

* update customize group

* update create content group

* shorten URLs

* update API group

* update deploy group

* update optimize and guides groups

* set up redirects

* update links

* add pdf page

* add missing icons

* remove default expanded state

* update docs.json
2025-10-01 11:55:34 -07:00