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

69 Commits

Author SHA1 Message Date
mintlify[bot] 257cd3f8cb fix: correct typos and broken JSON in docs (#6211) 
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
 2026-06-17 18:22:43 +00:00
Ethan Palm 7662f8fb2a Feedback resolution 2026 06 08 (#6123) 
* clarify MCP returns MD

* Fix doc issues surfaced by user feedback

- Fix claude mcp add --header argument order: the flag must come after
  the positional <name> and <url> args because --header is variadic and
  otherwise consumes everything that follows it, causing the "missing
  required argument 'name'" error users reported.
- Add tip to wrap iframes in Frame component to prevent overflow (user
  suggestion on image-embeds page).
- Fix broken anchor link in quickstart CLI tab: /cli/install has no
  #clone-your-repository section; replaced with inline git clone
  instructions and a correct link to /deploy/github.

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

* Document wide-mode behavior for side panel

Wide mode hides the entire side panel (not just the TOC), including
Panel components and OpenAPI request/response examples. This was
undocumented and actively confused a user who couldn't understand why
their OpenAPI example panels disappeared on wide-mode pages.

- Fix the wide mode description in organize/pages.mdx (it previously
  said only the TOC was hidden, but ContentSideLayout.tsx returns null
  for wide/center/custom modes entirely)
- Add a Note to components/panel.mdx calling out that the side panel
  is absent on wide, center, and custom pages

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

* Resolve user feedback: clarify path formats, load timing, and analytics config

- react-components: add Constraints section (hooks pre-injected, no npm, no default exports)
- posthog: fix default host from app.posthog.com to ph.mintlify.com (confirmed via source)
- plausible: add ParamField descriptions including server field explanation
- create/text: note that internal links require root-relative paths without file extensions
- create/image-embeds: clarify image paths are root-relative, relative paths unsupported
- create/redirects: show redirects as top-level field in full docs.json example
- customize/custom-scripts: note that custom JS runs after page is interactive, applies globally

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

* 💅

---------

Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
 2026-06-08 17:21:31 -07:00
mintlify[bot] 83fff5ff6b docs: clarify MDX escaping and standalone-page navigation pattern (#6097) 
* docs: clarify MDX character escaping and standalone-page navigation

* docs: mirror MDX escaping and navigation updates in fr and es

* Update organize/navigation.mdx

* 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-06-08 13:39:26 -07:00
mintlify[bot] 1db9c7e03e docs: document MDX comment syntax (#6029) 
* docs: document MDX comment syntax in text formatting page

* docs: translate MDX comments section into es and fr

---------

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
 2026-05-29 10:43:43 -07:00
mintlify[bot] 07865b2d62 docs: normalize gerund headings to imperative for consistency (#6002) 
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
 2026-05-26 16:34:31 -07:00
Ethan Palm 3020cbe6d6 Snippet variables in code blocks (#5973) 
* docs: document snippet variable interpolation in code blocks

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

* 💅

---------

Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
 2026-05-26 14:26:45 -07:00
mintlify[bot] 8fd60e91d1 docs: rename Ask AI to Ask Assistant in user-facing references (#5880) 
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
 2026-05-22 22:09:24 +00:00
mintlify[bot] d6da252c4f Document new changelog tag filter behavior (#5747) 
Generated-By: mintlify-agent

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
 2026-05-12 01:31:16 +00:00
mintlify[bot] 693dbc361f Fix Vale style warnings from PRs merged in the last week (#5690) 
* Fix Vale style warnings across docs from past week of merges

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 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 10:28:17 -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 ec5e78af4c Editor updates (#5603) 
* Update git-essentials.mdx

* Update index.mdx

* add v2 group

* recent updates

* remove v2 path

* small classic editor page

* add tutorial

* updates based on notion doc

* Create branching-and-publishing.mdx

* Update collaborate.mdx

* redirects

* update pages

* update create pages

* remove pages

* update redirects

* Update navigation.mdx

* remove redundancies

* update configurations

* 💅

* remove unused images

* update live preview

* correct image

* Add missing visual mode shortcuts and ungroup action

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

---------

Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
 2026-04-30 00:52:25 -07:00
mintlify[bot] abce73037a Add code example for title property syntax on code blocks (#5329) 
Generated-By: mintlify-agent

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
 2026-04-15 19:30:14 -07:00
mintlify[bot] d6960c72bf Improve SEO metadata across documentation pages (#5310) 
* Improve SEO metadata: fix titles, descriptions, and remove redundant OpenAPI descriptions

- Remove description frontmatter from 19 API pages where the OpenAPI spec already supplies the description
- Fix 2 titles that exceeded 60 characters (content-templates, content-types)
- Improve 15 descriptions that were too short (<130 chars) or too long (>160 chars) to target 130-155 characters
- All descriptions are unique and include relevant search terms

Generated-By: mintlify-agent

* re-add API descriptions

* 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-04-13 09:41:41 -07:00
mintlify[bot] 3a400692f0 Add horizontal rule documentation (#5158) 
* Add horizontal rule documentation to text formatting page

Generated-By: mintlify-agent

* 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-04-06 11:41:50 -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] 63f716768d Improve SEO descriptions on 19 pages (#5152) 
* Improve SEO descriptions on 19 pages with short metadata

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-06 10:26:12 -07:00
mintlify[bot] 58c9ad421a Fix Vale style warnings in recently changed files (#5090) 
* Fix Vale style warnings in recently changed files

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-02 13:17:31 -07:00
mintlify[bot] 911598a188 Update video upload size limit to 20 MB (#5092) 
* Update video upload size limit from 100 MB to 20 MB

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-02 11:12:24 -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] bcb55445ed Update custom heading IDs to include h5 and h6 support (#4875) 
* Update custom heading IDs to reflect h5 and h6 support

Generated-By: mintlify-agent

* remove note

---------

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-25 12:49:22 -07:00
mintlify[bot] 4bf21d4988 Document custom heading IDs syntax (#4786) 
Generated-By: mintlify-agent

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
 2026-03-23 12:20:58 -07:00
mintlify[bot] 670a7dce39 Document multi-word code block titles (#4722) 
* Update code block title docs to reflect multi-word title support

Generated-By: mintlify-agent

* Apply suggestion from @ethanpalm

* Apply suggestions from code review

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

* fix code blocks

---------

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 16:46:57 -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 0746a9082e Redirect status codes (#4228) 
* update settings

* update redirects
 2026-03-09 16:53:45 -07:00
mintlify[bot] fd3ca886e1 Improve diff syntax docs with language table (#4121) 
* Add Python example for diff syntax in code blocks

Generated-By: mintlify-agent

* Improve diff syntax documentation with language reference table

Generated-By: mintlify-agent

---------

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
 2026-03-06 15:06:40 -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 fe7effa348 Update redirects.mdx (#4033) 2026-03-04 17:02:30 -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] 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
Ethan Palm b746defeed Remove mov (#3350) 
* Update supported file types and keywords

* Apply suggestion from @ethanpalm
 2026-02-09 17:31:20 -08:00
Ethan Palm d342f3ee02 Document video upload features (#3348) 
* Update editor/media.mdx

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

* Update editor/media.mdx

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

* Update editor/pages.mdx

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

* Update create/files.mdx

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

* Apply suggestion from @ethanpalm

---------

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
 2026-02-09 17:25:46 -08:00
mintlify-development[bot] b3e87a5551 Fix broken link, code formatting, and clarify Node.js version (#3250) 
* Fix broken link, code formatting, and clarify Node.js version

* Apply suggestion from @ethanpalm

---------

Co-authored-by: Mintlify Agent <agent@mintlify.com>
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
 2026-02-09 09:22:06 -08:00
Ethan Palm 68d2199edd Re-add personalization information (#2981) 
* Document apiPlaygroundInputs

* add personalization info

* vale

* link to user data format instead of duplicating
 2026-02-02 08:24:16 -08:00
Ethan Palm 2360f1dc50 Document SVG foreign object restrictions (#3010) 2026-01-30 15:49:56 -08:00
Ethan Palm ba42d00e1e add note that anchors aren't supported in redirects (#3008) 2026-01-30 14:58:10 -08:00
Ethan Palm e819807cd8 rename "custom" to "enterprise" (#2997) 2026-01-30 10:34:54 -08:00
mintlify[bot] e7f026b953 Update create/changelogs.mdx (#2768) 
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
 2026-01-20 14:36:42 -08:00
Ethan Palm cbb51323ab Revert "Update redirect documentation to reflect 308/307 status codes (#2674)" (#2688) 
This reverts commit d32bf059ba.
 2026-01-14 10:41:49 -08:00
mintlify[bot] d32bf059ba Update redirect documentation to reflect 308/307 status codes (#2674) 
* Update organize/settings.mdx

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

* Update create/redirects.mdx

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

* Update create/redirects.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-13 22:21:39 -08:00
Ethan Palm 428d38fb9e Feedback fixes (#2603) 
* add explanation of plausible server

* add info on aligning table columns

* clarify API keys

* add example API use cases

* update link to API auth

* remove passive voice
 2026-01-08 10:12:33 -08:00
Kyle Finken 6943d615d8 Update snippets docs for implicit snippets (#2597) 
* Update snippets docs for implicit snippets

title

* copyedit

---------

Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
 2026-01-08 09:28:48 -08:00
Ethan Palm ea2642b19c Update redirects documentation for root-level slug support (#2589) 
* Update create/redirects.mdx

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

* simplify

---------

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
 2026-01-07 17:09:50 -08:00
mintlify[bot] 257562172a Document partial wildcard redirects (#2433) 
* Update create/redirects.mdx

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

* document partial wildcard matching

---------

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
 2025-12-18 14:22:02 -08:00
Kyle Finken 80384c69c1 Remove docs around snippets config (#2436) 
We are refactoring the snippets solution this removes the documentation around that solution and refactors it
 2025-12-18 13:56:15 -08:00
Ruhan Ponnada 895c6a1942 Add warning about infinite redirect loops in redirects documentation (#2429) 
* Update create/redirects.mdx

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

* Update warning message for redirect rules

Clarified warning about redirect rules to prevent infinite loops.

---------

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
 2025-12-18 09:37:32 -08:00
Ethan Palm c6eddf0158 Snippets v3 docs (#2363) 
* add snippets prop

* update path info in React page

* update snippets page

* reviewer feedback
 2025-12-16 18:56:56 -08:00
Ethan Palm 100689f9d5 RSS changelog information (#2274) 
* add RSS info to update component

* update changelog RSS info
 2025-12-12 15:40:32 -08:00
Kyle Finken 53c29313fe Add a tip for relative snippets imports (#2247) 
title
 2025-12-12 10:57:06 -08:00
Ethan Palm 5d1b1da440 update supported file types (#2221) 2025-12-11 13:42:46 -08:00