Commit Graph

93 Commits

Author SHA1 Message Date
mintlify[bot] 66c2834f19 Update from code changes: document analytics event streaming (#6694)
* docs: document analytics event streaming to Amazon S3

* docs: wrap translated streaming headings with anchor ids

* docs: document streamed deployments selector for analytics streaming

* translations

* 💅

---------

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-23 16:52:56 -07:00
mintlify[bot] a0c62bbe91 Apply SEO and metadata best practices (#6715)
* docs: improve SEO titles and descriptions for feedback pages

* 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-23 15:18:51 -07:00
Ethan Palm f6cc41fc6e Clarify agent feedback (#6714)
* docs: clarify agent feedback submission paths

* 💅
2026-07-23 15:08:21 -07:00
mintlify[bot] ade1fbbd39 Documentation quality check: fill gaps in recently updated pages (#6633)
* docs: address reader-question gaps in recently updated pages

* docs: shorten analytics description, split long sentence, mirror translations

---------

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
2026-07-17 15:06:01 +00:00
mintlify[bot] f9791f2845 docs: tighten long sentence in analytics page (#6597)
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
2026-07-16 08:50:58 -07:00
mintlify[bot] 626a6c0623 docs: hyphenate "click-through" and "free-form" in analytics/feedback pages (#6599)
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
2026-07-16 01:17:28 +00:00
Ethan Palm 1e2955559b Analytics UI update (#6596)
* update analytics page

* update feedback page
2026-07-15 18:14:58 -07:00
mintlify[bot] 27134fcb4e Documentation quality check: fill reader-question gaps on 3 pages (#6571)
* docs: address reader-question gaps in custom scripts, seo, and settings reference

* docs: translate custom scripts, seo, and settings reference edits to es/fr/zh

* Update organize/settings-reference.mdx

* Update customize/custom-scripts.mdx

* fix code fence

* 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-15 10:40:13 -07:00
mintlify[bot] 74aa617407 docs: close unterminated code fence in optimize/seo.mdx (#6565)
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
2026-07-14 22:45:09 +00:00
skeptrune f5eb16e900 Document seo.organization and the JSON-LD structured data graph (#6561)
* Document seo.organization and the JSON-LD structured data graph

* Fix lint warnings: spaced em dashes, node24 action versions

* Update optimize/seo.mdx

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

---------

Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
2026-07-14 15:42:37 -07:00
mintlify[bot] ed3a2e4799 Update from code changes: document seo.trailingSlash option (#6533)
* docs: document seo.trailingSlash config option

* docs: wrap translated trailingSlash headings with anchor divs

* 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-14 14:56:54 -07:00
mintlify[bot] ef8659c0eb fix: correct sentence punctuation in SEO indexing note (#6555)
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
2026-07-14 17:43:03 +00:00
Ethan Palm 20bfad9ddf 💅 2026-07-14 10:38:14 -07:00
Ethan Palm 6aca45ca9d docs: document automatic structured data (JSON-LD) generation
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
2026-07-14 10:12:51 -07:00
mintlify[bot] 54f9721835 Apply brand tone and writing style fixes (#6532)
* docs: apply brand tone and writing style fixes

* 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-07-13 16:31:33 -07:00
mintlify[bot] a253499e26 Apply SEO and metadata best practices (#6480)
* docs: improve SEO metadata for search configuration page

* 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-09 17:12:54 -07:00
Ethan Palm 8ff018c7b4 add search filter info (#6479) 2026-07-09 15:33:52 -07:00
Ethan Palm 34a90d1324 copyedit 2026-07-08 12:28:59 -07:00
mintlify[bot] e7fbece5b6 Update from code changes: document PDF export page selection (#6403)
* docs: document page selection option for PDF exports

* update exports link

* add second procedure

* spanish

* french

* chinese

---------

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-07 15:12:03 -07:00
mintlify[bot] ca993c5d3f docs: note Enterprise plan for contextual and code snippet feedback (#6420)
* docs: update feedback types callout to note Enterprise plan requirement

* 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-07 13:34:51 -07:00
Ethan Palm 682665e31f docs: document themes and sentiment in assistant analytics
Assistant analytics now assigns conversations granular categories
grouped under broader themes, with thumbs-up/thumbs-down sentiment
at each level. Update the categories section to match and fix a
grammar slip in the July 2 changelog entry.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
2026-07-06 15:58:38 -07:00
Ethan Palm 3b4209d853 Update gated product info for pro plan (#6400)
* docs: add plan availability callouts for agent, automations, REST API, and analytics

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

* 💅

---------

Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
2026-07-06 15:45:53 -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] 7f89731d79 docs: apply brand tone and writing style fixes to analytics page (#6355)
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
2026-07-01 17:11:01 -07:00
Ethan Palm 9afe33e0b0 explain agent metrics (#6354) 2026-07-01 17:08:15 -07:00
mintlify[bot] cf671d7abf Documentation quality check: address gaps in recently updated pages (#6339)
* docs: address gaps in recently updated pages

* docs: translate page-gap fixes to es, fr, zh

* Apply suggestions from code review

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

* Update multi-repo.mdx

* add line breaks

---------

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-01 11:44:38 -07:00
mintlify[bot] f9c4d6c4f0 Documentation quality check: address gaps in recently updated pages (#6326)
* docs: address quality-check gaps across recent page updates

* docs: mirror quality-check fixes into es, fr, and zh translations

* 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-30 13:41:22 -07:00
mintlify[bot] 756d730c40 Update from code changes: document searchable frontmatter (#6312)
* docs: document searchable frontmatter for per-page search opt-out

* docs: tighten sentence length in searchable usage guidance

* docs: clarify searchable:false also excludes AI assistant context

* docs: tighten searchable ResponseField sentence length

---------

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
2026-06-29 12:03:54 -07:00
mintlify[bot] e015e2d19e Vale style audit: fix warnings from PRs merged in the last week (#6278)
* docs: fix Vale warnings from PRs merged in the last week

* docs: mirror Vale style fixes into es/fr/zh translations

* 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-06-25 09:24:44 -07:00
mintlify[bot] e5d1791438 docs: remove mint analytics CLI command (#6221)
* docs: remove mint analytics CLI command

* docs: tighten CLI page descriptions for SEO

* Apply suggestion from @ethanpalm

* clean up redirects.json

---------

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-18 10:22:10 -07:00
mintlify[bot] a6ec4be434 docs: fix Vale warnings from PRs merged in the last week (#6222)
* 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>
2026-06-18 10:09:09 -07:00
mintlify[bot] c53752118c docs: document project-level noindex setting (#6152)
* docs: document project-level noindex setting

* docs: wrap translated noindex headings with anchor divs

* 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-11 11:37:11 -07:00
mintlify-development[bot] 241ac82fb5 docs: PDF exports now supported for authenticated sites (#6138)
* docs: note full-site PDF exports now support authenticated sites

* Update optimize/pdf-exports.mdx

---------

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-06-09 17:21:10 -07:00
mintlify[bot] f2c3147e8a docs: generalize analytics CSV export to cover all tabs (#6136)
* docs: generalize analytics CSV export to cover all tabs

* docs: translate analytics CSV export updates to fr and es

* 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-09 17:15:47 -07:00
mintlify[bot] 458fcfd792 docs: clarify per-page PDF downloads work on authenticated sites (#6104)
* docs: clarify per-page PDF downloads work on authenticated sites

* Update optimize/pdf-exports.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-06-08 11:22:25 -07:00
Leyland Yang 8b337fabd8 Document contextual PDF download option (#6075)
* Document contextual PDF download option

* Tighten contextual PDF docs update

* Remove contextual docs formatting change

* add enterprise gate

* add link in pdf-exports page

* Update pdf-exports.mdx

---------

Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
2026-06-04 09:22:50 -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
Dean from Mintlify 485d8b0828 Improve SEO metadata clarity in optimize/seo.mdx (#6008)
Mintlify-Source: dashboard-editor
2026-05-27 13:25:47 -07:00
mintlify[bot] f965fb35de docs: document Content-Signal directives in auto-generated robots.txt (#5966)
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
2026-05-26 15:49:51 -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
Ethan Palm 94ac3bcae3 PDF language selector (#5975)
* docs: document language selector option for PDF exports

* 💅
2026-05-26 15:20:27 -07:00
skeptrune 1fedb88ca4 docs: convert search-boost page into general Search config page (#5851)
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.
2026-05-18 12:00:39 -07:00
skeptrune bea304041c docs: document searchable for hidden tabs and groups (#5837)
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.
2026-05-16 15:58:11 -04: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] 1c25c440f8 docs: update sales contact email on feedback page (#5725)
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
2026-05-08 13:25:19 -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] 96993ddd49 docs: clarify detailed feedback only shows submissions with additional info (#5669)
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
2026-05-05 16:25:26 -04: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] 2016c35157 Audit and improve SEO frontmatter across docs (#5649)
Generated-By: mintlify-agent

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
2026-05-02 04:32:23 +00:00
mintlify[bot] f8fd6e6d73 Fix duplicate Tailwind class and broken frontmatter quote (#5648)
Generated-By: mintlify-agent

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
2026-05-02 03:10:29 +00:00