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
98793b5df8
Clarify when docs.json server config is required for manual API pages ( #3057 )
2026-02-02 15:46:16 -08:00
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
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
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
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
d09a313240
remove mcp section ( #2192 )
2025-12-10 14:59:37 -08:00
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
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
08c2b10f7d
fix asyncAPI setup link ( #1802 )
2025-11-19 17:51:43 -08:00
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💅
* update descriptions
* fix title
* add missing keywords
* fix YAML
2025-11-17 15:51:49 -08:00
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
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
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
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
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
4149a52a3b
add alt text ( #1442 )
2025-10-03 13:07:36 -07:00
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
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
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
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
ef880d1b9d
Replace references to '/api' in docs ( #1167 )
2025-09-16 16:45:25 -07:00
1cb6eabd93
Fix code sample highlighting ( #1033 )
...
* fix code sample highlighting
* update sample highlighting
2025-08-15 14:41:05 -07:00
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
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
9ae5f16ce2
Highlighting fix ( #1019 )
2025-08-12 11:25:18 -07:00
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
97b37683e8
add x-mint: mcp ( #1000 )
2025-08-07 10:30:42 -07:00
b64d3c8df0
Capitalize href ( #998 )
2025-08-06 14:28:18 -07:00
6f16b62ce4
Nit about version and deprecated ( #995 )
2025-08-06 13:14:54 -07:00
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
8cb398e8f6
Add webhooks section to OpenAPI setup ( #894 )
...
* add webhooks section
* put version requirements in context
2025-07-14 10:28:16 -07:00
55f5ed205c
Specify page-level playground settings ( #889 )
...
* Claude Code's commit
* edit page-level playground info
2025-07-08 13:39:56 -07:00
1912ba56f6
Fix broken link in API Playground troubleshooting page ( #873 )
...
* fix broken link
* copyedit
2025-06-30 15:54:11 -07:00
2b150e5749
Change titles to sentence case ( #833 )
...
* change titles to sentence case
* make groups sentence case
2025-06-19 10:15:15 -07:00
40d2e2cd2d
Add proper language support for syntax highlighting to all code blocks ( #807 )
...
* Add proper language support for syntax highlighting to all code blocks
* Camel case inline code
2025-06-11 12:38:15 -07:00
63d2c68002
Update support content ( #767 )
...
* move github troubleshooting info
* remove duplicate API troubleshooting info
* move SVG info to cards page
* move `/api` 404 info to navigation
* move and rename support
* update support info
* copyedits
* fix wording
* typo fix
2025-05-30 11:51:21 -07:00
6f00cd27e5
API playground docs refresh ( #723 )
...
* add outline
* update overview
* add a quickstart
* update grouping and titles
* Add getting started info to overview
* update info on adding openAPI doc
* remove repeated link
* update info on auto-generating pages
* remove mindsdb image
* update MDX info
* remove files combined into OpenAPI setup
* add redirects
* rewrite MDX intro
* upate steps
* undo reorging MDX content
* create files for customization group
* update `docs.json`
* add content for complex data types
* add content for managing page visibility
* Add SDK examples content
* delete advanced features page
* add description for SDK page
* add info on multiple responses
* fix broken links
* Copilot edits
* Copy edit overview
* Copy edit of OpenAPI setup
* Copyedit customization pages
* consistent heading capitalization
* add reviewer feedback
2025-05-28 11:53:38 -07:00
85cf8815f8
add deprecated tag info to mdx setup ( #711 )
2025-05-19 12:21:33 -07:00
69854396cb
Documentation edits made through Mintlify web editor
2025-05-11 16:18:01 -07:00
841fefb8ec
Documentation edits made through Mintlify web editor
2025-05-11 16:11:16 -07:00
55a038437f
Use mint CLI
2025-05-05 16:14:38 -07:00
e83f797443
Root level core concepts ( #687 )
2025-05-05 14:56:44 -07:00
88c3d9e396
update x-hidden docs and include other label ( #675 )
2025-04-30 12:44:51 -07:00
b75a6d6714
Update overview
2025-04-28 11:26:39 -07:00
ea94790b29
Updated navigation pages
2025-04-28 01:04:52 -07:00
3384ea43f1
Use core-concepts
2025-04-24 11:43:25 -07:00
b82428f298
Update to use lucide icons
2025-04-23 16:55:28 -07:00
e7bba7904e
Add "x-hidden" docs ( #665 )
...
* add x-hidden docs
* fix broken link
* fix link for real
* doi fix the other link
2025-04-23 15:07:15 -07:00
4ec6818121
Asyncapi Docs ( #629 )
...
* add page about asyncapi setup
* add playground page
* update docs
* add single channel page docs
* delete unneeded paragraph
* add local+remote
* Update api-playground/asyncapi/setup.mdx
Co-authored-by: Hahnbee Lee <55263191+hahnbeelee@users.noreply.github.com >
* add asyncapi playground
---------
Co-authored-by: Hahnbee Lee <55263191+hahnbeelee@users.noreply.github.com >
2025-04-11 09:05:05 -07:00
mintlify[bot]