Quick Ref / Command

Engineer Kit

/ak:mintlify

Mintlify docs sites

Build and maintain Mintlify docs sites across docs.json, MDX components, navigation, frontmatter, theming, API docs, AI assets, deployment, and local Mintlify CLI checks.

01

Scope the Mintlify task

02

Inspect docs.json

03

Plan navigation and content

04

Author MDX pages

Rule 01

docs.json defines theme, navigation, branding, colors, and integrations

Rule 02

MDX pages should use Mintlify frontmatter and built-in components

Rule 03

API docs can be generated from OpenAPI or AsyncAPI specs with playgrounds and examples

Rule 04

AI docs assets such as llms.txt and skill.md are first-class Mintlify deliverables

Execution Map

Core lanes from input to output, aligned with the command's real execution path.

01

Start

Input, scope, route

  1. 1 Scope the Mintlify task Confirm whether the request targets site structure, MDX content, docs.json config, navigation, API docs, AI docs assets, deployment, or local checks.
  2. 2 Inspect docs.json Review theme, branding, colors, integrations, navigation groups, tabs, anchors, products, versions, languages, and existing page frontmatter.
02

Work

Agent / skill execution

  1. 3 Plan navigation and content Choose supported Mintlify themes, locales, navigation patterns, page modes, redirects, and component usage that match the existing docs site.
  2. 4 Author MDX pages Write frontmatter and MDX with Mintlify-specific components such as Note, CodeGroup, Steps, API components, callouts, diagrams, and interactive blocks.
03

Verify

Gate, review, validation

  1. 5 Connect API and AI docs Add OpenAPI or AsyncAPI documentation, playgrounds, multi-language examples, llms.txt, skill.md, MCP support, and contextual AI menu options when needed.
  2. 6 Run local checks Use the relevant Mintlify CLI commands: mint dev for preview, mint validate for docs.json, mint broken-links, mint a11y, and mint openapi-check.
04

Close

Report, handoff, artifact

  1. 7 Prepare deployment Align the site with GitHub or GitLab auto-deploy, preview deployments, custom domains, subpath hosting, or Vercel, Cloudflare, and AWS targets.

Syntax, arguments, subcommands

How to invoke the skill: syntax, positional arguments, shared options, then each subcommand with its own syntax and outcome.

Syntax

/ak:mintlify [task] [path]

Arguments

[task] Required

Docs task

Natural-language outcome, constraints, allowed files, validation commands, and stop points. It should not grant hosted account, dashboard, DNS, Git, preview publication, or deployment permission by itself.

/ak:mintlify "In ./docs-site, add an Authentication group, run mint validate and mint broken-links, and stop before deployment."
[path]

Docs root

Optional repository path to the Mintlify project or docs root. Include it when the target is not obvious from the current workspace.

/ak:mintlify "Update API navigation" ./docs-site

Sample Prompt

Concrete invocations for each flag, subcommand, mode, or route available in the live workflow.

Docs structure Recommended
/ak:mintlify reorganize API docs navigation
Use when:
Use when Mintlify docs site structure, navigation, or page grouping needs work.
Expected:
Reworks docs.json navigation using supported groups, tabs, anchors, products, versions, or language patterns while preserving page frontmatter.
MDX page
/ak:mintlify add quickstart page with Steps and CodeGroup
Use when:
Use when adding or improving Mintlify MDX content pages.
Expected:
Creates or updates an MDX page with correct frontmatter and Mintlify components such as Steps, CodeGroup, Note, callouts, or diagrams.
API docs
/ak:mintlify connect OpenAPI spec to docs site
Use when:
Use when Mintlify interactive API documentation is needed.
Expected:
Connects OpenAPI or AsyncAPI specs to Mintlify API documentation, including playground behavior, multi-language examples, and openapi-check validation.
Local checks
/ak:mintlify run local validation for docs.json and links
Use when:
Use when a Mintlify docs site needs preview, configuration, links, accessibility, or API-spec checks before shipping.
Expected:
Runs the relevant Mintlify CLI path such as mint dev, mint validate, mint broken-links, mint a11y, or mint openapi-check and reports fixes needed.

Handled Scope

  • docs.json configuration
  • MDX frontmatter and Mintlify components
  • Navigation architecture and localization
  • OpenAPI and AsyncAPI documentation
  • AI docs assets: llms.txt, skill.md, and MCP support
  • Mintlify CLI preview and validation

Artifacts Produced

Mintlify Docs Site Output

Pattern

docs.json + MDX pages + API or AI docs assets + relevant mint CLI checks

Mintlify work should preserve the site structure, use supported configuration and components, and run the local checks relevant to the changed surface.

Next