Commit Graph

27 Commits

Author SHA1 Message Date
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] 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
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 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
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] 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] 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 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
Ethan Palm 4149a52a3b add alt text (#1442) 2025-10-03 13:07:36 -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
Ricardo Nunez ef880d1b9d Replace references to '/api' in docs (#1167) 2025-09-16 16:45:25 -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 1912ba56f6 Fix broken link in API Playground troubleshooting page (#873)
* fix broken link

* copyedit
2025-06-30 15:54:11 -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 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
Han Wang 55a038437f Use mint CLI 2025-05-05 16:14:38 -07:00
Han Wang e83f797443 Root level core concepts (#687) 2025-05-05 14:56:44 -07:00
Han Wang 3384ea43f1 Use core-concepts 2025-04-24 11:43:25 -07:00
Han Wang b82428f298 Update to use lucide icons 2025-04-23 16:55:28 -07:00
Dean from Mintlify df4a94d7a5 Documentation edits made through Mintlify web editor 2025-04-07 14:38:20 -07:00
Dean from Mintlify 80fecb0b9b quick fix to improve the OpenAPI pages (#552)
* quick fix to improve the OpenAPI pages

* clarrified that the URL for the OAS can be added to the docs.json
2025-03-31 17:18:30 -07:00
Ruhan Ponnada da0b605d83 Replacing mint.json to docs.json (#506)
* Replacing mint.json to docs.json for everythin except versioning and navigation

* Reflected docs.json for navigation and versioning
2025-02-04 20:24:52 -08:00
Mayank Shouche 9780b5b05e add troubleshooting & resolution for openapi v2 (#283) 2024-10-03 14:31:41 -07:00
Ronan McCarter b0951a79d6 docs: add troubleshooting for api pages (#267)
* add troubleshooting for api pages

* make description more generic

* add example for filenames and fix info

* DNS provider -> reverse proxy
2024-09-06 10:21:28 -07:00