44 Commits

Author SHA1 Message Date
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
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
Han Wang 913a524d11 Fix 2026-04-14 19:12:41 -07:00
mintlify[bot] 245183021a Fix broken links on landing pages (#5376)
* Fix broken links on landing pages missing /docs base path

Generated-By: mintlify-agent

* undo localized changes

---------

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-14 18:41:35 -07:00
Ethan Palm baf530dedc Refresh homepage (#4656)
* them -> luma

* redo landing page

* refine

* spacing

* use images for cards

* searchbar

* searchbar

* reduce pop in

* adjust gradient

* accessibility

* gradient

* fuzz

* gradient colors

* gradient

* add icon

* frame mode

* update cards

* remove support card

* edit bottom cards

* rename image

* make search a button, add aria labels

* color contrast

* Apply suggestions from code review

Co-authored-by: dmytro <71014515+pqoqubbw@users.noreply.github.com>

* gradient on hover

* add color

* remove background image

* fix parsing error

* fix pop in

* pop in

* fix search icon

* fix link

---------

Co-authored-by: dmytro <71014515+pqoqubbw@users.noreply.github.com>
2026-04-14 18:22:50 -07:00
Ethan Palm 59c05c29a6 Revert "make it relative urls again (#5074)" (#5075)
This reverts commit 86bb587a76.
2026-04-01 13:47:55 -07:00
ryan nguyen 86bb587a76 make it relative urls again (#5074) 2026-04-01 13:28:54 -07:00
ryan nguyen 41e47f94ed Revert "revert: restore S3 image URLs for documentation (#5063)" (#5065)
This reverts commit 7b418252f4.
2026-04-01 11:31:16 -07:00
Brandon McConnell 7b418252f4 revert: restore S3 image URLs for documentation (#5063)
* chore: reset files to state of commit 454825d

* Add assistant caller stats API endpoint (#5057)

Generated-By: mintlify-agent

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

* Translate assistant caller stats endpoint into es, fr, zh (#5058)

Generated-By: mintlify-agent

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

---------

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
2026-04-01 11:05:45 -07:00
Brandon McConnell edd4534bf4 fix: use github raw urls for image assets (temporary) (#5054)
* 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.
2026-04-01 00:51:24 -07:00
mintlify[bot] 43b3783e8c Replace S3 URLs with relative paths for theme and hero images (#5051)
Generated-By: mintlify-agent

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
2026-04-01 00:14:46 -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
Ethan Palm f33c9dd8b7 Editor docs (#2490)
* create files and update docs.json

* draft of overview

* keyboard shortcuts draft

* draft of publishing

* draft of collaborate

* configurations draft

* media draft

* content draft

* navigation draft

* edit shortcuts

* update overview

* update media page and add images

* collaborate edits

* reorder nav

* publish edits

* copy edit publish

* publish 💅

* remove redundancy

* demo commit

* fix tooltips

* make configurations focused on tasks

* update index

* rename content.mdx to pages.mdx

* copy edit pages

* make configuration section more task-based

* 💅 pages

* remove old editor page

* add redirect

* 💅 navigation

* add more nav elements

* fix tooltip

* update numbering

* update redirects

* update links

* fix redirect loop

* remove columns
2025-12-22 19:06:24 -08:00
mintlify[bot] e303bc939c Pull request for mintlify/docs-improvements-84149 (#1990)
* Update index.mdx

* Update quickstart.mdx

* Update guides/improving-docs.mdx

* Update guides/style-and-tone.mdx

* Update guides/content-types.mdx

* Apply suggestions from code review

* Update guides/style-and-tone.mdx

---------

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
2025-12-02 10:25:54 -08:00
Ethan Palm 84461981ac Add higher res background images (#1983)
* higher res background images

* transform Y axis

* fix pop in

* empty commite

* use SVG

* remove unused PNGs

* remove unused classes

* adjust image position

* add opacity
2025-12-01 15:26:00 -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
Han Wang 1429925dda Change it back to almond 2025-11-12 09:53:59 -08:00
Ethan Palm a19ff08287 Update theme (#1739)
* use willow

* set homepage to `custom`
2025-11-11 16:38:25 -08:00
Kaishan (Sam) Ding c6032c2c7f fix: top two hero cards not clickable (#1499) 2025-10-08 13:40:00 -07:00
mintlify-development[bot] d255ced34c Update index.mdx (#1435)
Co-authored-by: mintlify-development[bot] <109878554+mintlify-development[bot]@users.noreply.github.com>
2025-10-06 09:24:21 -07:00
Han Wang d63a86f14f Trying the almond theme just to feel something 2025-10-05 14:37:38 -07:00
Ethan Palm befa80e35d add alt text (#1445) 2025-10-03 14:09:31 -07: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
Han Wang 57f53dcc9d Simplify index 2025-08-19 22:33:10 -07:00
Han Wang 3e6dc2f7ed Use local images 2025-08-19 22:30:49 -07:00
Han Wang a70e29fdd6 Update links 2025-08-14 13:35:06 -07:00
Han Wang e4fae67723 Add block 2025-08-13 14:51:56 -07:00
Han Wang 92ba4f2697 H1 to prod 2025-08-13 14:43:59 -07:00
Han Wang 79b044b521 Revert to div 2025-08-13 14:38:29 -07:00
Han Wang a51e2d52ae Revert back to h1 to test 2025-08-13 14:29:35 -07:00
Han Wang 6412e5968e Fix h1 tags 2025-08-13 00:47:57 -07:00
Ajit Panigrahi 8be2fbc180 fix: Update links on index (#1012) 2025-08-09 13:53:09 -07:00
skeptrune 87ea644422 fix: layout shift on introduction page for docs (#917) 2025-07-16 11:03:34 -07:00
Han Wang d68ff10e98 Update tags 2025-05-21 09:53:03 -07:00
Han Wang cabdfe9f6e Update logo for hero 2025-05-03 10:42:39 -07:00
Han Wang c0bc5f974a Update max width on homepage 2025-05-02 16:13:44 -07:00
Han Wang 8606bc0dd6 Update terminal light 2025-05-02 15:15:50 -07:00
Han Wang cadded67e1 Update background images 2025-05-02 15:08:53 -07:00
Kaishan (Sam) Ding 5f93c99b23 Documentation edits made through Mintlify web editor (#683) 2025-05-01 13:27:22 -07:00
Han Wang caa757fe53 Documentation edits made through Mintlify web editor 2025-04-29 15:39:32 -07:00
Han Wang 010c7facec Update docs 2025-04-26 16:39:37 -07:00
Han Wang 2601414d3d Remove subheader 2025-04-26 15:36:24 -07:00
Han Wang 414b797ce2 Update pages 2025-04-24 11:28:25 -07:00
Han Wang fe394eccf0 Rename to intro page 2025-04-23 19:13:52 -07:00