definable-docs-writing

Define and maintain Mintlify MDX docs with an audit-driven workflow.

27|4|Updated Jun 12, 2025
One-click install
npx skills add https://github.com/definableai/definable.ai --skill definable-docs-writing
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: definable-docs-writing
Source: https://github.com/definableai/definable.ai/tree/main/.cursor/skills/definable-docs-writing
Command: npx skills add https://github.com/definableai/definable.ai --skill definable-docs-writing

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Provide a structured process for creating and updating Definable AI documentation, ensuring alignment with code, consistent MDX pages, and up-to-date navigation.

Core Features & Use Cases

  • Audit-before-edit workflow to assess changes before publishing.
  • Mintlify MDX conventions, templates, and component usage guidance.
  • Navigation config guidance and code example standards to keep docs in sync with code.

Quick Start

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

Frequently Asked Questions about definable-docs-writing

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

FAQPage Schema
How do I structure Mintlify MDX pages for new features?

Mintlify MDX pages require enforced frontmatter for name and description to structure new features. Optional scripts, references, and assets can be included to align documentation with code.

What is an audit-driven workflow for documentation updates?

An audit-driven documentation workflow assesses changes before publishing to ensure consistent MDX pages and up-to-date navigation. It evaluates new features or updates prior to editing.

How do I update navigation config in docs.json?

Update docs.json navigation config by adding the new Mintlify page entries to keep documentation in sync with code. This ensures the navigation structure aligns with newly created MDX pages.

Do I need frontmatter for every Mintlify MDX page?

Yes, frontmatter is required for every Mintlify MDX page to enforce the presence of name and description. This maintains consistent documentation standards across all feature updates.

What's the best way to maintain documentation consistency with code updates?

The best way to maintain documentation consistency is applying an audit-driven workflow that aligns Mintlify MDX conventions and docs.json navigation config with code updates.

Can I include optional scripts and assets in Mintlify documentation?

Yes, you can include optional scripts, references, and assets in Mintlify MDX pages. The structured workflow supports these additions alongside required frontmatter for name and description.