142 Commits

Author SHA1 Message Date
mintlify[bot] f66b301e00 fix: revert hosted docs URLs to mintlify.site domain (#7272)
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
2026-09-07 12:19:54 -04:00
mintlify[bot] 0fc1205c85 fix: apply Vale audit vocab and rule fixes for last week's changes (#7238)
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
2026-09-03 08:59:04 -07:00
Leyland Yang db88b6fd8c docs: replace mintlify.site with mintlifysite.com (#7226)
Claude-Session: https://claude.ai/code/session_01NrNcqnQqnVxY8H1epWe88p
2026-09-02 14:42:34 -07:00
mintlify[bot] d903166b3e fix: correct typos, grammar, and a missing MDX import across docs (#7128)
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
2026-08-26 11:23:06 -07:00
mintlify[bot] 4ef881bee9 docs: fix search MCP card title typo in quickstart (#7126)
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
2026-08-26 11:11:12 -07:00
Ethan Palm e14d2ec28b add search MCP card to quickstart (#7123) 2026-08-26 11:04:58 -07:00
mintlify[bot] 4c56dd5a93 Shipped Channel Updates: document new agent-generated onboarding (#7098)
* docs: update quickstart for new agent-generated onboarding

* docs: translate onboarding quickstart update and tighten wording

---------

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
2026-08-25 11:44:54 -07:00
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 ce50a41e23 mint signup visibility components (#6850)
* add CLI visibility components

* add quickstart visibility components
2026-08-03 14:21:13 -07:00
Nivedh Mudiam 804051af12 docs: add AI setup agent prompt to quickstart (#6781)
* docs: add AI setup agent prompt to quickstart

* remove redundant SkillMcpPrompt

* Apply suggestions from code review

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

---------

Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
2026-07-28 14:02:46 -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
Ethan Palm 7662f8fb2a Feedback resolution 2026 06 08 (#6123)
* clarify MCP returns MD

* Fix doc issues surfaced by user feedback

- Fix claude mcp add --header argument order: the flag must come after
  the positional <name> and <url> args because --header is variadic and
  otherwise consumes everything that follows it, causing the "missing
  required argument 'name'" error users reported.
- Add tip to wrap iframes in Frame component to prevent overflow (user
  suggestion on image-embeds page).
- Fix broken anchor link in quickstart CLI tab: /cli/install has no
  #clone-your-repository section; replaced with inline git clone
  instructions and a correct link to /deploy/github.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* Document wide-mode behavior for side panel

Wide mode hides the entire side panel (not just the TOC), including
Panel components and OpenAPI request/response examples. This was
undocumented and actively confused a user who couldn't understand why
their OpenAPI example panels disappeared on wide-mode pages.

- Fix the wide mode description in organize/pages.mdx (it previously
  said only the TOC was hidden, but ContentSideLayout.tsx returns null
  for wide/center/custom modes entirely)
- Add a Note to components/panel.mdx calling out that the side panel
  is absent on wide, center, and custom pages

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* Resolve user feedback: clarify path formats, load timing, and analytics config

- react-components: add Constraints section (hooks pre-injected, no npm, no default exports)
- posthog: fix default host from app.posthog.com to ph.mintlify.com (confirmed via source)
- plausible: add ParamField descriptions including server field explanation
- create/text: note that internal links require root-relative paths without file extensions
- create/image-embeds: clarify image paths are root-relative, relative paths unsupported
- create/redirects: show redirects as top-level field in full docs.json example
- customize/custom-scripts: note that custom JS runs after page is interactive, applies globally

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* 💅

---------

Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-06-08 17:21: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] 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
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
Kaishan (Sam) Ding 40947f0ea9 fix (#5635) 2026-05-01 14:06:08 -07:00
Ethan Palm 490436fda9 use snippet for repeated prompt (#5628) 2026-05-01 11:29:29 -07:00
mintlify[bot] c33a91e87f Update quickstart and AI docs (#5614)
Mintlify-Source: dashboard-editor

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
2026-04-30 14:47:01 -07:00
mintlify[bot] 1b8c6673fb docs: remove auto-generate callout from quickstart (#5591)
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
2026-04-28 22:33:45 -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
Ethan Palm 67af10ce48 fix links (#5370) 2026-04-14 17:47:25 -07:00
Ethan Palm db3ca0500d CLI updates (#5150)
* update skills

* update migration guide

* update API migration guide

* update assistant page

* update analytics page

* update CLI commands

* deprecate openapi-check

* add coming soon

* update docs.json

* add index page

* add install page

* add preview page

* add analytics

* add commands reference

* update links

* delete installation.mdx

* add optional prereq steps

* Add telemetry section to commands reference

Incorporates telemetry content from #5039 which was merged to main after
this branch was created. Documents opt-out flags, env variables, and
config persistence.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* move global flags to top

* vale

* remove `mint upgrade`

* remove unnecessary prereq

* restructure analytics commands

---------

Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-04-06 10:40:51 -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 4a6281825b Auto-generate docs sites (#3938)
* vale

* add new page to nav

* add tip to quickstart

* add auto-generate page

* add to migration guide

* add languages for codeblocks

* copyedits

* 💅

* update quickstart link

* remove auto-generate page

* add example to tip

* vale
2026-03-03 09:40:33 -08:00
mintlify[bot] e9da369dff Fix Vale style warnings: future tense to present tense (#3823)
* Fix Vale style warnings: replace future tense with present tense

Generated-By: mintlify-agent

* 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-02-26 16:39:36 -08:00
mintlify[bot] 2225cc12ec Add Prompt component documentation (#3393)
* Update components/prompt.mdx

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

* Update components/index.mdx

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

* copy edit

* consolidate examples

* add prompt to quickstart

* use prompt for the description

* give agents MD

* add prompt to nav

---------

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
2026-02-11 16:52:37 -08:00
Ethan Palm 662afd5b28 Update Mintlify skill (#3317)
* create Mintlify docs skill

* move URL

* add step to load product knowledge

* remove redundancy with default skill.md

* consolidate into default skill.md

* add tip to quickstart
2026-02-09 12:59:57 -08:00
dks333 6b2b8fbc2a Revert "Refactor documentation structure and content (#3281)"
This reverts commit 159232d90d.
2026-02-08 19:39:32 -08:00
dks333 ff4bdac782 Revert "Update quickstart guide"
This reverts commit a02e9f9e17.
2026-02-08 19:39:28 -08:00
mintlify-development[bot] a02e9f9e17 Update quickstart guide 2026-02-09 03:26:52 +00:00
mintlify-development[bot] 159232d90d Refactor documentation structure and content (#3281)
Co-authored-by: mintlify-development[bot] <109878554+mintlify-development[bot]@users.noreply.github.com>
2026-02-09 03:22:14 +00:00
Han Wang 6cbb1c9d87 Testing again (#3248)
* Update quickstart guide

* Update quickstart guide

* Update quickstart guide

* Update quickstart guide

---------

Co-authored-by: mintlify-development[bot] <109878554+mintlify-development[bot]@users.noreply.github.com>
2026-02-08 20:15:07 +00:00
mintlify-development[bot] aecd9721a6 Fix broken API links and improve keyword coverage (#3251)
* Fix broken links and improve keyword coverage

- Fix API reference links using incorrect /api-reference/ path (should be /api/)
- Add missing period to agent API link
- Add relevant keywords to installation and deployments pages
- Specify Node.js version in troubleshooting section

* Apply suggestion from @tembo[bot]

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

---------

Co-authored-by: Mintlify Agent <agent@mintlify.com>
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
Co-authored-by: tembo[bot] <208362400+tembo[bot]@users.noreply.github.com>
2026-02-08 09:53:59 -08:00
Han Wang 889a825cfd Update quickstart and settings documentation (#3246)
* Update quickstart and settings documentation

* Update organize/settings.mdx content

* Update quickstart and settings documentation

* Update settings documentation

---------

Co-authored-by: mintlify-development[bot] <109878554+mintlify-development[bot]@users.noreply.github.com>
2026-02-08 03:53:03 +00:00
Ethan Palm 3974d12fd8 remove mention of frontmatter in web editor (#2983) 2026-01-30 09:35:51 -08:00
mintlify[bot] b07a3ee82b Add SEO keywords to quickstart (#2940)
* Update quickstart.mdx

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

* Apply suggestion from @tembo[bot]

Co-authored-by: tembo[bot] <208362400+tembo[bot]@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>
Co-authored-by: tembo[bot] <208362400+tembo[bot]@users.noreply.github.com>
2026-01-28 13:30:55 -08:00
dmytro 02905e693c fix: remove Columns wrapper for the next steps (#2621) 2026-01-09 17:31:21 +01:00
Han Wang ccc30217b5 undo relative pages for french relative page 2025-12-30 22:05:44 -06:00
Han Wang 2f192163fd Test for local files 2025-12-30 21:57:10 -06: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
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
Ethan Palm 052669129e stack cards (#2488) 2025-12-22 13:56:18 -08:00
Ethan Palm 7e355e9276 Re-add CLI instructions to quickstart (#2485)
* add CLI instructions to quickstart

* one path

* polish up
2025-12-22 13:17:30 -08: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] 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 66faccbf93 Documentation edits made through Mintlify web editor (#1864)
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
2025-11-24 16:22:50 -08:00
Han Wang 9e1a2bad7c Remove hello world 2025-11-17 09:04:16 -08:00
Han Wang 07725e354e Merge branch 'main' of https://github.com/mintlify/docs 2025-11-17 09:03:59 -08:00