Commit Graph

46 Commits

Author SHA1 Message Date
mintlify[bot] b6d7c8a549 docs: document shared organization credit balance (#6799)
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
2026-07-28 17:28:28 -07:00
mintlify[bot] fa840111cc Update from code changes: document assistant widget language and version filter (#6789)
* docs: document assistant widget language and version filter

* docs: wrap translated heading in anchor div and prefix links with language code

---------

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
2026-07-28 13:54:23 -07:00
mintlify[bot] fde32f8c35 Apply SEO and metadata best practices (#6772)
* docs: lengthen widget description for SEO

* 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>
2026-07-28 10:33:06 -07:00
mintlify[bot] e02ce699a1 Apply brand tone and writing style fixes (#6773)
* docs: apply brand tone and writing style fixes to widget page

* Update assistant/widget.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-07-28 08:26:15 -07:00
Kaishan (Sam) Ding 83b34463d2 update widget description (#6771) 2026-07-27 18:48:43 -07:00
mintlify[bot] 741ee2c6c9 docs: remove inconsistent bold emphasis in widget config table (#6766)
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
2026-07-27 17:42:12 -07:00
Kaishan (Sam) Ding e10cfd0019 feat: assistant widget (#6754)
* feat: assistant widget

* fix

* docs: rename Assistant Widget to Mintlify Widget

* docs: shorten widget sidebar title

* add starter questions + support email

* new playground

* update

* fix

* remove bg

* remove bg

* fix

* update link

* resolve merge conflicts

* update intro, copy edit

* add prerequisites and confirmation step

* vale warning

* fix

* fix

* fkx

* fix

* fix

* live preview

* fix

---------

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
2026-07-27 17:37:11 -07:00
mintlify[bot] 92f9dfaae7 docs: clarify Assistant.md is not served publicly from .mintlify/ (#6590)
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
2026-07-15 16:59:43 -07:00
mintlify-development[bot] c8259a2ff6 Update from support feedback: assistant network/VPN troubleshooting (#6428)
* docs: document network-level blocks for the assistant

* Apply suggestion from @ethanpalm

---------

Co-authored-by: mintlify-development[bot] <109878554+mintlify-development[bot]@users.noreply.github.com>
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
2026-07-08 14:32:17 -07:00
mintlify[bot] 096718df78 Update from code changes: document assistant contact form opt-out (#6417)
* docs: document assistant contact form opt-out setting

* docs: clarify contact form opt-out applies only to support questions

* 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>
2026-07-08 08:25:59 -07:00
Kyle Finken 4894f12f0c Update docs for new Pro pricing (#6386) 2026-07-03 21:22:47 -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] 5daf64144f docs: apply brand tone and writing style fixes to assistant/configure (#6372)
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
2026-07-02 15:26:42 -07:00
mintlify[bot] 1af1643297 fix: hyphenate compound modifier in assistant skills page (#6371)
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
2026-07-02 22:24:22 +00:00
Ethan Palm 1c693a133a chore: style edits for assistant skills (#6369)
* docs: style pass on assistant skills page

Align the assistant skills page (added in #6363) with docs style
standards: tighter intro without promotional language, language tag
on the directory tree code block, active voice, prose instead of a
behavior bullet list, and action-oriented headings.

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

* 💅

---------

Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
2026-07-02 15:22:24 -07:00
Ethan Palm 8406dd54da Assistant support/sales form fields (#6368)
* docs: update assistant contact form fields after lead capture redesign

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

* 💅

---------

Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
2026-07-02 15:22:09 -07:00
mintlify[bot] 2152fdfeb5 Update from code changes: document assistant skills (#6363)
* docs: document assistant skills

* docs: translate assistant skills page and mirror nav

---------

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
2026-07-02 11:17:48 -07:00
mintlify[bot] e6319a30a7 docs: document support and sales deflection emails for the assistant (#6357) 2026-07-01 21:01:01 -07:00
mintlify[bot] 3ca550b188 Update from code changes: switch hosted docs domain to mintlify.site (#6296)
* 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>
2026-06-26 10:51:54 -07:00
Ethan Palm 2c99f3c736 Revert "Update from code changes: hosted docs domain is now mintlify.site (#6…" (#6285)
This reverts commit 553e2813ac.
2026-06-25 14:10:23 -07:00
mintlify[bot] 553e2813ac Update from code changes: hosted docs domain is now mintlify.site (#6282)
* docs: update hosted docs domain to mintlify.site

* docs: tighten zh reverse proxy intro for translation parity

---------

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
2026-06-25 11:58:10 -07:00
Patrick Foster 65f6e60f31 Rename workflows to automations across docs (#6227) 2026-06-18 16:44:22 -07:00
mintlify[bot] d721125b2f docs: fix Vale warnings from PRs merged in the last week (#6153)
* docs: fix Vale warnings from PRs merged in the last week

* 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>
2026-06-11 10:14:58 -07:00
Ethan Palm 162c0b6ec1 clarify MCP returns MD (#6118) 2026-06-08 14:34:31 -07:00
Ethan Palm 873e58ad89 Use starter/ent credit tiers (#6059)
* use starter/ent tiers

* Update configure.mdx
2026-06-02 12:37:06 -07:00
mintlify[bot] bb1081c88b docs: use active voice in assistant credit tier step (#6055)
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
2026-06-02 10:57:31 -07:00
mintlify[bot] 8678abd430 docs: hobby trial and credit bundle billing flow (#6052)
* docs: update credits and assistant billing for hobby trial and credit bundle

* docs: translate hobby trial and credit bundle updates to es and fr

* revert changes to credits page

* 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-06-02 10:52:40 -07:00
Ethan Palm 564f4a768a Update plan gates (#6043)
* configure assistant on starter plan

* assistant

* update workflows changelog note

* auth

* Update custom-frontend.mdx

* remove pro plan
2026-06-01 14:29:31 -07: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] 8fd60e91d1 docs: rename Ask AI to Ask Assistant in user-facing references (#5880)
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
2026-05-22 22:09:24 +00:00
mintlify[bot] 371cb0922d Fix style inconsistencies: third person and verb choice (#5802)
- Change third-person 'Users' to second-person 'you' in assistant/use.mdx intro
- Change 'Choose' to 'Select' for consistency with procedural verb pattern

Generated-By: mintlify-agent

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
2026-05-21 23:37:12 +00:00
mintlify[bot] b99882d82e Document credit package purchases for Hobby plan users (#5758)
Generated-By: mintlify-agent

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
2026-05-12 18:02:37 +00:00
mintlify[bot] 9bf7d2a941 Document overages disabled by default for assistant (#5752)
Generated-By: mintlify-agent

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
2026-05-12 01:31:29 +00: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
Ethan Palm 33b031fed6 Update assistant credit package language (#5701)
* Update configure.mdx

* credits roll over
2026-05-07 16:43:35 -07:00
mintlify[bot] 9c3a933bb5 docs: remove RAG references from assistant page (#5700)
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
2026-05-07 15:01:53 -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
mintlify[bot] 3fe4dca86b Update assistant billing docs for new dashboard copy (#5683)
* Update assistant billing docs to match new dashboard copy

Generated-By: mintlify-agent

* Refine package section name and add View usage shortcut

Generated-By: mintlify-agent

---------

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
2026-05-07 10:10:49 -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] cbc5fb070b Fix style consistency issues across docs (#5641)
* Fix style consistency issues across docs

Generated-By: mintlify-agent

* 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>
2026-05-01 16:26:44 -07:00
mintlify[bot] 0bcb69f80b Update assistant billing links to Organization Usage page (#5621)
Generated-By: mintlify-agent

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
2026-05-01 09:03:02 -07:00
mintlify[bot] 2039fb3e30 Document ?assistant URL parameter (#5620)
* Document ?assistant URL parameter for opening assistant

Generated-By: mintlify-agent

* Note assistant permission requirement for ?assistant param

Generated-By: mintlify-agent

* Apply suggestion from @ethanpalm

* Apply suggestion from @ethanpalm

* 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>
2026-05-01 08:39:14 -07:00
mintlify[bot] e86695d617 Remove ?assistant= URL parameter docs (#5594)
Generated-By: mintlify-agent

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
2026-04-29 13:40:19 -07:00
mintlify[bot] b9cfd7824b Add AI tool tips to key docs pages (#5582)
* Add AI tool tips and skill.md install prompts to key pages

Generated-By: mintlify-agent

* 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>
2026-04-28 17:10:34 -07:00
mintlify[bot] d45477d10f Improve SEO metadata across docs (#5536)
* Improve SEO metadata across docs

Generated-By: mintlify-agent

* revert api/* changes

* Update components/cards.mdx

* Update components/visibility.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-04-27 09:06:38 -07:00
Ethan Palm 6187247856 Create assistant group (#5411)
* add redirect

* update links

* remove old page

* create index page

* Create configure.mdx

* Create customize.mdx

* Create use.mdx

* Update docs.json
2026-04-16 11:09:02 -07:00