skills/mintlify__docs
1
0
Fork 0
mirror of https://github.com/mintlify/docs.git synced 2026-09-14 13:35:46 +08:00
Code Issues Packages Projects Releases Wiki Activity
3,222 Commits 1,654 Branches 0 Tags
mintlify/ddbbbf18
Commit Graph

157 Commits

Author SHA1 Message Date
mintlify[bot] 21abbffaa1 docs: tighten four overly long sentences for readability (#6116) 
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
 2026-06-08 11:25:19 -07:00
mintlify[bot] b14f773db6 docs: document OpenAPI callbacks on API reference pages (#5968) 
* docs: document OpenAPI callbacks rendering on API reference pages

* docs: add zh translation and wrap callback headings with anchor div

* Apply suggestion from @ethanpalm

* copy edit

---------

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-28 10:46:57 -07:00
skeptrune ef65919462 docs: document the download-spec contextual option (#6014) 
* Document download-spec contextual option

* Enable download-spec contextual option on mintlify docs site

* Explain download-spec on the OpenAPI setup page
 2026-05-28 10:42:21 -07:00
mintlify[bot] 83dad38714 docs: fix UI button styling and step punctuation in OpenAPI troubleshooting (#5987) 
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
 2026-05-26 15:51:51 -07:00
mintlify[bot] 21f454e8d6 docs: fix minor style inconsistencies across English docs (#5996) 
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
 2026-05-26 15:51:25 -07:00
mintlify[bot] 674ef1a5f0 docs: replace "leveraging" with plainer wording in complex data types (#5995) 
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
 2026-05-26 15:50:49 -07:00
mintlify[bot] ec195789cb docs: remove filler words flagged by style guide (#5978) 
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
 2026-05-26 15:43:16 -07:00
mintlify[bot] a268d81a3d docs: make duplicate page titles unique for SEO (#5985) 
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
 2026-05-26 15:41:34 -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
Ethan Palm f333a38afc API playground schema updates (#5980) 
* docs: document AsyncAPI schema rendering and any/undefined type handling

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

* 💅

---------

Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
 2026-05-26 15:20:21 -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] 6955f30257 Document nested group support for AsyncAPI (#5682) 
* Document nested group support for AsyncAPI

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-07 10:15:34 -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] 6c4c23c0b7 Document custom parameter pills via x-mint and api.params.post (#5545) 
Generated-By: mintlify-agent

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
 2026-04-27 15:17:51 -07:00
mintlify[bot] 1f5c74a14e Update OpenAPI troubleshooting for trailing slash tolerance (#5478) 
* Update troubleshooting to reflect trailing slash tolerance in OpenAPI path resolution

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-04-22 13:18:54 -07:00
mintlify[bot] 8b893333f5 Document x-group extension and MCP skill resources (#5299) 
* Document x-group extension and MCP skill resources

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-15 19:28:12 -07:00
mintlify[bot] 0b0c8af624 Fix Vale style warnings from recent merged PRs (#5247) 
* Fix Vale style warnings across 11 documentation files

Convert passive voice to active voice, fix sentence-style capitalization,
and update word choice per Vale linter suggestions.

Generated-By: mintlify-agent

* Apply suggestions from code review

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

* 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-04-10 14:00:16 -07:00
mintlify[bot] 18ff07ab23 Add sidebarTitle to x-mint metadata example (#5244) 
Generated-By: mintlify-agent

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
 2026-04-09 11:18:59 -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
mintlify[bot] a0ee4ef597 Fix Vale style warnings from recent PRs (#4900) 
* Fix Vale style warnings from recent PRs

Generated-By: mintlify-agent

* alphabetize accept list

* remove unnecessary terms

* combine lists

* alphabetize

* add (?i)

* update wordlist

* remove default vocab

* Apply suggestions from code review

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

* Update accept.txt

---------

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-26 10:18:53 -07:00
mintlify[bot] b96ab99a5d Document x-default extension for API playground (#4781) 
* Document x-default extension for security schemes and schema properties

Generated-By: mintlify-agent

* 💅

---------

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-24 18:51:59 -07:00
mintlify[bot] da6c06367c Document api.playground.credentials option (#4823) 
* Document api.playground.credentials option for cross-origin requests

Generated-By: mintlify-agent

* Tighten credentials field description in playground overview

- Fix terminology inconsistency: brief description now matches the expanded
  explanation (cookies, authorization headers, TLS client certs)
- Remove editorializing ("This is useful when...") to match style of
  surrounding proxy field

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.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>
Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
 2026-03-23 17:28:05 -07:00
mintlify[bot] 5e38e26fba Add tip about using API trigger with URL-based OpenAPI specs (#4802) 
Generated-By: mintlify-agent

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
 2026-03-23 10:18:19 -07:00
mintlify[bot] 6b5350804d Fix Vale warnings from recent PRs (#4697) 
* Fix Vale warnings from recent PRs

Generated-By: mintlify-agent

* Apply suggestion from @ethanpalm

* Apply suggestion from @ethanpalm

* Apply suggestion from @ethanpalm

* Update accept.txt

* Apply suggestion from @ethanpalm

* Apply suggestion from @ethanpalm

* update vale config

---------

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-19 10:23:35 -07:00
mintlify[bot] 0ea741f964 Add documentation for parameter anchor links feature (#4442) 
Generated-By: mintlify-agent

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
 2026-03-13 16:20:21 -07:00
Ethan Palm 9d0640aafb Improve settings page IA and readability (#4446) 
* settings overview page

* update docs.json

* update links in icons snippets

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

* add schema reference

* add api settings

* add appearance settings

* add integrations settings

* add seo and search settings

* add structure

* add new contextual options

* update links

* Vale

---------

Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
 2026-03-13 16:17:34 -07:00
Ethan Palm 21f174f3cb chore: offsite doc issues (#4392) 
* API playground response rendering, proxy behavior

* Fix response rendering description: other responses use code block with JSON detection

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

* 💅

---------

Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
 2026-03-12 16:05:10 -07:00
mintlify[bot] 07b9cb425c Add .NET alias to supported languages table (#4087) 
Generated-By: mintlify-agent

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
 2026-03-06 13:33:42 -08:00
mintlify[bot] 6b8f86ca60 Document audio response examples (#3604) 
* Update api-playground/multiple-responses.mdx

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

* copyedit

---------

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-06 10:13:03 -08:00
mintlify-development[bot] ad11bc265d Fix Vale style warnings: passive voice and punctuation (#4057) 
* Fix Vale style warnings: passive voice and punctuation

- Convert passive voice to active voice in multiple component docs
- Fix quotation mark punctuation in navigation.mdx
- Update heading text to use correct casing
Style-only changes that don't affect content meaning.
Generated-By: mintlify-agent

* 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-03-06 09:11:24 -08:00
mintlify-development[bot] 0a96456433 Add api.url configuration documentation (#4040) 
* Add api.url configuration documentation

Generated-By: mintlify-agent

* 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-03-05 17:58:44 -08:00
mintlify[bot] dbdb1a298b Fix Vale style warnings across documentation (#4036) 
* Fix Vale style warnings across documentation

Generated-By: mintlify-agent

* Apply suggestion from @ethanpalm

* Apply suggestion from @ethanpalm

* Apply suggestions from code review

* Update guides/automate-agent.mdx

* Update integrations/analytics/adobe.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-03-05 10:11:54 -08:00
Ethan Palm 3dc3852b7a SEO descriptions (#4028) 
* Improve SEO descriptions across 47 pages

Curated descriptions from two bot-generated PRs (#3908, #3949),
selecting the best approach for each page:
- Added missing title and description frontmatter to 10 API reference pages
- Benefit-focused descriptions for integration pages (not implementation-heavy)
- Accurate REST-aligned titles for API endpoints (Export, List, Trigger, etc.)
- Expanded short descriptions to 50–160 character range throughout

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

* copyedit

* Update custom-domain.mdx

* Fix analytics API page titles to match spec summaries

"Export" was inaccurate — spec uses "Get" for both endpoints.
Also updated descriptions to use "Retrieve" for consistency.

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

---------

Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
 2026-03-04 16:46:28 -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] 8f98214405 Document OpenAPI spec download URLs (#3757) 
* Add tip about downloading OpenAPI specs

Generated-By: mintlify-agent

* Move OpenAPI download tip to openapi-setup.mdx

* Replace tip callout with prose

* 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-24 18:12:35 -08:00
mintlify[bot] 6268d03cc2 style: convert future tense to present tense (#3717) 
* style: convert future tense 'will' to present tense across docs

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 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-02-24 12:05:49 -08:00
mintlify[bot] 387af2fc7c Fix Vale style errors: AMPM format and ly-hyphens (#3607) 
Generated-By: mintlify-agent

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
 2026-02-20 17:16:06 -08:00
mintlify[bot] 6803ad3144 Fix Vale style errors: spacing, units, and phrasing (#3582) 
Generated-By: mintlify-agent

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
 2026-02-20 09:21:18 -08:00
Ethan Palm ab04a0c437 fix anchor links (#3516) 2026-02-17 16:06:55 -08:00
mintlify[bot] 16444e61ed Add supported languages accordion (#3314) 
* Add accordion listing all 18 supported languages

* Update accordion with correct 18 supported languages

* add display names and aliases

---------

Co-authored-by: Mintlify Agent <agent@mintlify.com>
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
 2026-02-09 14:01:09 -08:00
mintlify-development[bot] fcf93e1608 Fix broken link and remove redundant heading (#3257) 
Co-authored-by: Mintlify Agent <agent@mintlify.com>
 2026-02-09 09:19:15 -08:00
mintlify[bot] 4db5914680 Clarify OpenAPI and AsyncAPI version support (#3148) 
* Update api-playground/openapi-setup.mdx

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

* Update api-playground/openapi-setup.mdx

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

* Update api-playground/asyncapi-setup.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>
 2026-02-05 18:00:39 -08:00
Ethan Palm 98793b5df8 Clarify when docs.json server config is required for manual API pages (#3057) 2026-02-02 15:46:16 -08:00
Taylor Tran a0c61cbe00 Update api-playground/openapi-setup.mdx (#3037) 
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
 2026-02-02 10:27:00 -08:00
mintlify[bot] 1ee69b4bdd Add documentation for auth playground display mode (#2989) 
* Update api-playground/overview.mdx

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

* Update api-playground/overview.mdx

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

* Update api-playground/openapi-setup.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>
 2026-01-30 08:59:08 -08:00
Ethan Palm ec7e679407 Document api.examples.autogenerate config option (#2794) 
* Update api-playground/overview.mdx

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

* Update organize/settings.mdx

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

* Update api-playground/overview.mdx

* Update organize/settings.mdx

---------

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
 2026-01-22 10:05:57 -08:00
Ethan Palm 3e20041feb Clarify multiple API specification files (#2537) 
* add asyncapi example

* add examples to settings

* add openAPI examples

* clarify multiple API specs are supported

* editor specific

* Update openapi-setup.mdx
 2026-01-05 13:18:31 -08:00
Ethan Palm d09a313240 remove mcp section (#2192) 2025-12-10 14:59:37 -08:00