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
2,499 Commits 1,654 Branches 0 Tags
Matthew-Demo
Commit Graph

131 Commits

Author SHA1 Message Date
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
mintlify[bot] c30529371c Add manual endpoint navigation example to MDX setup guide (#1921) 
* Update api-playground/mdx-setup.mdx

* Update api-playground/mdx-setup.mdx

* Update api-playground/mdx-setup.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-11-26 14:06:41 -05:00
Ethan Palm 6f0cf51504 Document support for .md (#1900) 
* replace `MDX` with `Markdown` where appropriate

* favor MDX

* Emphasize .md is for migration, .mdx is recommended

* favor MDX

* missing words
 2025-11-25 19:15:15 -08:00
Ethan Palm 08c2b10f7d fix asyncAPI setup link (#1802) 2025-11-19 17:51:43 -08:00
Ethan Palm 30d7e22acf Flatten "Document APIs" group (#1752) 
* consolidate MDX group into single page

* update nav and redirects

* match filename to title

* revise intro and setup

* update auth section

* remove outdated intro

* copyedit overview

* add link to example endpoint page

* remove asyncapi subdirectory

* 💅

* move MDX content out of OpenAPI setup

* copyedit openapi-setup

* Revert "move MDX content out of OpenAPI setup"

This reverts commit 3baed8e572.

* copyedit mdx-setup

* clean up openapi-setup

* task-based title

* fix title

* copyedit manage page visibility

* 💅

* update descriptions

* fix title

* add missing keywords

* fix YAML
 2025-11-17 15:51:49 -08:00
mintlify[bot] 39c1ae39c3 Clarify OpenAPI multiple documents support and $ref limitations (#1782) 
* Update api-playground/openapi-setup.mdx

* Update api-playground/openapi-setup.mdx

* Update api-playground/openapi-setup.mdx

* Update api-playground/openapi-setup.mdx

* concision

* copyedit

---------

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
 2025-11-17 13:03:33 -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
Ethan Palm 4b68a8e5ec Update descriptions for SEO (#1767) 
* add global metatags

* set "indexing": "all"

* update AI group descriptions

* api-playground descriptions

* root level page descriptions

* component descriptions

* create descriptions

* customize descriptions

* dashboard descriptions

* deploy descriptions

* guides descriptions

* insights descriptions

* api-playground

* organize descriptions

* Integrations descriptions
 2025-11-13 17:14:39 -08:00
Kathryn Isabelle Lawrence 3a87014f2d Fix missing "s" on components.schemas OpenAPI doc section (#1630) 
it's components.schemas, not components.schema: https://swagger.io/specification/#components-object
 2025-10-28 09:43:00 -07:00
mintlify[bot] 3e8722e919 Add documentation for API playground prefill feature (#1461) 
* Update organize/settings.mdx

* Update api-playground/overview.mdx

* Update api-playground/overview.mdx

* Apply suggestions from code review

* Update api-playground/overview.mdx

Co-authored-by: Kathryn Isabelle Lawrence <lawr3ka@gmail.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: Kathryn Isabelle Lawrence <lawr3ka@gmail.com>
 2025-10-06 10:47:16 -07:00
Ethan Palm 4149a52a3b add alt text (#1442) 2025-10-03 13:07:36 -07:00
mintlify[bot] fc279667cc Fix typos in documentation (#1440) 
* Update api-playground/overview.mdx

* Update customize/themes.mdx

---------

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
 2025-10-03 12:46:08 -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
Kathryn Isabelle Lawrence da88524e74 Add filename in openapi-schema frontmatter docs (#1347) 
* add filename in openapi-schema frontmatter docs

* english is my first language
 2025-09-26 11:54:21 -07:00
mintlify[bot] 4bc40db8f8 Documentation edits made through Mintlify web editor (#1242) 
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
 2025-09-23 09:48:11 -07:00
Ricardo Nunez ef880d1b9d Replace references to '/api' in docs (#1167) 2025-09-16 16:45:25 -07:00
Ethan Palm 1cb6eabd93 Fix code sample highlighting (#1033) 
* fix code sample highlighting

* update sample highlighting
 2025-08-15 14:41:05 -07:00
Ethan Palm 7b84148ce1 x-mint migrate script (#1023) 
* add command to CLI page

* add steps for CLI migration

* reviewer feedback
 2025-08-15 10:58:17 -07:00
Ethan Palm b6c9df22fc MCP tool updates (#1022) 
* update `x-mint:  mcp` info

* fix JSON examples

* update MCP

* include `securityRequirement`

* include responseField for mcp object

adds x-mint.mcp.name and x-mint.mcp.description

* update availability

* move troubleshooting to the bottom

* add `mcp` as keyword

* use tabs for installation options

* add VS code MCP install to contextual menu

* make it more clear what contextual menu does

* add tabs for how to connect MCP server to popular tools

* update Mintlify example

* fix VS Code since did it everywhere else

* fix contextual menu label

* update placeholder values

* make buttons look nicer
 2025-08-14 16:07:43 -07:00
Michael Cho 9ae5f16ce2 Highlighting fix (#1019) 2025-08-12 11:25:18 -07:00
Michael Cho a6feb60f64 Openapi nav updates (#1008) 
* add troubleshooting info

* update conceptual info in MDX setup

* add OpenAPI section to navigation page

* update overview steps

* Update info about customizing endpoint pages

* update setup information

* fix typo

* add migration guide

* clarify allowed metadata

* more precise terms

* explain `directory` field

* clarify you can use multiple OpenAPI specs

* navigation reviewer feedback

* troubleshooting reviewer feedback

* overview reviewer feedback

* setup reviewer feedback

* fewer things to troubleshoot

* update auto-populate API pages section

* update JSON example

* update default OpenAPI spec example

* update spec inheritance example

* replace example

* fix overview JSON examples

* update navigation example

* update troubleshooting example

* Update openapi-setup.mdx

* Update migration guide

* update JSON examples

---------

Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
 2025-08-11 17:27:34 -07:00
Ethan Palm 97b37683e8 add x-mint: mcp (#1000) 2025-08-07 10:30:42 -07:00
Michael Cho b64d3c8df0 Capitalize href (#998) 2025-08-06 14:28:18 -07:00
Michael Cho 6f16b62ce4 Nit about version and deprecated (#995) 2025-08-06 13:14:54 -07:00
Ethan Palm f632ff1cc0 x-mint (#927) 
* add troubleshooting info

* update conceptual info in MDX setup

* add OpenAPI section to navigation page

* update overview steps

* Update info about customizing endpoint pages

* update setup information

* fix typo

* add migration guide

* clarify allowed metadata

* more precise terms

* explain `directory` field

* clarify you can use multiple OpenAPI specs

* navigation reviewer feedback

* troubleshooting reviewer feedback

* overview reviewer feedback

* setup reviewer feedback

* fewer things to troubleshoot

* update auto-populate API pages section

* remove navigation content

* reviewer feedback
 2025-08-05 16:42:24 -07:00
Ethan Palm 8cb398e8f6 Add webhooks section to OpenAPI setup (#894) 
* add webhooks section

* put version requirements in context
 2025-07-14 10:28:16 -07:00
Ethan Palm 55f5ed205c Specify page-level playground settings (#889) 
* Claude Code's commit

* edit page-level playground info
 2025-07-08 13:39:56 -07:00