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,578 Commits 1,654 Branches 0 Tags
testing2
Commit Graph

48 Commits

Author SHA1 Message Date
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
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
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] 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] 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 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-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] 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
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] 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 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
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
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
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
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
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 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 55f5ed205c Specify page-level playground settings (#889) 
* Claude Code's commit

* edit page-level playground info
 2025-07-08 13:39:56 -07:00
Ricardo Nunez 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
Ethan Palm 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
Han Wang b75a6d6714 Update overview 2025-04-28 11:26:39 -07:00
Han Wang 10a469dc98 Remove plants 2025-03-31 20:22:38 -07:00
Han Wang 1e3e79d622 Update a lot of nits 2025-02-17 01:21:37 -08:00
Han Wang 8f8c3c3c54 Update docs 2025-02-16 20:42:06 -08:00
Han Wang dd0cfb14fd Han/update layout and add icons (#211) 
* Add icons and update layout

* Clarify configs and remove unused color configs

* Adjust quotes
 2024-07-14 18:14:13 -07:00
Han Wang 1c54715705 Use OpenAPI for sample response 2023-10-20 01:01:02 +08:00
Ronan McCarter 0782b745f0 reorganize docs for openapi 2023-10-10 12:02:50 -07:00
Kate Chen 41870f0c55 update playground docs 2023-08-10 13:54:18 -07:00
Nico Zweifel 1f6efc57ac Update overview.mdx (#40) 2023-06-15 09:12:21 +02:00
Kate Chen 242d43fda9 fix component links 2023-06-14 15:38:26 -05:00
Benjamin Shen 5edfc755a1 Fix broken links 2023-06-03 02:04:00 -07:00
jessiihu 1c72477cfc added info about api-reference folder 2023-05-02 13:23:50 -07:00
Rishi 3a21473e91 fix: typo api-playground overview 2023-04-21 19:18:13 +01:00
jessiihu acb7e9383b Resolved Han's Comments 2023-04-12 10:54:13 -07:00
jessiihu 2a55210c50 Low level doc improvements 2023-04-11 12:37:30 -07:00
Han Wang 1aa8d30aa3 Fix typo as hide instead of hidden 2023-04-07 10:44:31 -07:00
Han Wang 19273cc5d2 Update demo to overview page 2023-04-07 10:09:17 -07:00