lcp-mintlify-docs

Edit the Mintlify docs site under docs/. Keep docs.json consistent and run a11y/broken-links checks.

⭐2stars🔀0forks📁View on GitHub🕐Updated Jan 8, 2026

When & Why to Use This Skill

This Claude skill automates the management and maintenance of Mintlify-based documentation sites. It streamlines technical content editing, ensures navigation consistency via docs.json, manages multi-language support (English and Japanese), and performs critical quality assurance checks including accessibility (a11y) and broken link validation to ensure a high-quality, SEO-friendly documentation experience.

Use Cases

  • Automated Documentation Maintenance: Efficiently edit and update technical content within the docs/ directory while keeping the docs.json navigation configuration perfectly synchronized.
  • Multi-language Content Management: Seamlessly manage Japanese documentation mirrors by maintaining the -ja suffix convention and ensuring structural parity with English pages.
  • Automated Quality Assurance: Run Mintlify-specific validation scripts to detect broken links and ensure accessibility (a11y) compliance before deploying documentation updates.
  • Navigation and Structure Optimization: Manage complex documentation hierarchies and frontmatter consistency to improve site crawlability and user navigation.
namelcp-mintlify-docs
descriptionEdit the Mintlify docs site under docs/. Keep docs.json consistent and run a11y/broken-links checks.
short-descriptionWork on Mintlify docs content and navigation

You are editing the documentation site under docs/ (Mintlify).

Scope

  • Site config: docs/docs.json
  • Pages and assets: docs/**
  • Local validation scripts: docs/scripts/check-docs-json.mjs

Workflow

  1. Prefer repo-root-relative links so the link checker resolves paths consistently.
  2. Japanese pages mirror English pages using a -ja suffix and live alongside them.
  3. Keep navigation (docs/docs.json) and page frontmatter consistent.

Validation (run from docs/)

  • node scripts/check-docs-json.mjs
  • npx --yes mintlify@4.2.255 a11y
  • npx --yes mintlify@4.2.255 broken-links

Optional local preview:

  • npx --yes mintlify@4.2.255 dev --no-open