mintlify

Define and codify Mintlify documentation structure and navigation best practices.

1|1|Updated Sep 28, 2023
One-click install
npx skills add https://github.com/gocobalt/mintlify-docs --skill mintlify-gocobalt
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: mintlify
Source: https://github.com/gocobalt/mintlify-docs/tree/main/.agents/skills/mintlify
Command: npx skills add https://github.com/gocobalt/mintlify-docs --skill mintlify-gocobalt

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Mintlify projects require consistent structure, navigation, and tooling to keep documentation up-to-date as teams scale. This skill provides guidance for building and maintaining docs sites with Mintlify, ensuring frontmatter, docs.json navigation, and integration with AI features are consistently applied across multilingual repos.

Core Features & Use Cases

  • Standardized page frontmatter and docs.json navigation to enable reliable discovery and navigation.
  • Guidelines for integrating the Mintlify AI assistant and agent to automate content updates and improvements.
  • Use cases include onboarding new team members, configuring MCP servers for live data, and maintaining multilingual documentation.

Quick Start

Create a new MDX page for Mintlify docs and update docs.json to include it in the navigation.

Frequently Asked Questions about mintlify

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I configure docs.json navigation for a Mintlify documentation site?

To configure docs.json navigation for Mintlify, you define standardized page structures and navigation hierarchies. This ensures reliable content discovery and consistent navigation across your documentation project as your team scales.

What's the best way to integrate the Mintlify AI assistant into my docs workflow?

Integrating the Mintlify AI assistant involves using provided guidelines to automate content updates and improvements. This approach enables AI-driven documentation maintenance and keeps your docs current without manual intervention.

Do I need specific frontmatter for MDX pages in a Mintlify project?

Yes, MDX pages in Mintlify require standardized frontmatter for consistent documentation. This skill codifies frontmatter best practices to ensure your MDX content is properly structured and reliably rendered within the docs site.

How do I set up and maintain multilingual documentation with Mintlify?

Maintaining multilingual documentation with Mintlify requires consistent structure and tooling across translated repos. This skill provides specific guidelines to ensure frontmatter and navigation are uniformly applied across all language variations.

Can I use Mintlify to configure MCP servers for live data in documentation?

Yes, you can configure MCP servers for live data within Mintlify documentation. This use case is supported by the skill's guidelines, allowing you to connect external data sources and display live information in your docs.

How do I add a new MDX page to an existing Mintlify docs project?

Adding a new MDX page to Mintlify docs requires creating the file with proper frontmatter and updating docs.json to include it in the navigation. This skill codifies the process for standardizing page creation and site organization.