lcp-mintlify-docs

Validate Mintlify docs structure, links, and accessibility with docs/scripts/check-docs-json.mjs.

2|Updated Dec 30, 2025
One-click install
npx skills add https://github.com/YusukeShimizu/lightning-compute-protocol --skill lcp-mintlify-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: lcp-mintlify-docs
Source: https://github.com/YusukeShimizu/lightning-compute-protocol/tree/main/.codex/skills/lcp-mintlify-docs
Command: npx skills add https://github.com/YusukeShimizu/lightning-compute-protocol --skill lcp-mintlify-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps maintain the Mintlify docs site under docs/ by ensuring navigation and references stay in sync and by running accessibility and broken-link checks to prevent issues in production docs.

Core Features & Use Cases

  • Docs consistency: Keep docs.json aligned with the actual docs structure and navigation.
  • Accessibility & integrity: Run a11y checks and link validation to catch issues early.
  • Operational workflow: Provide a repeatable process for validating changes before deployment.

Quick Start

Use the lcp-mintlify-docs Skill to update docs/ and run validation commands locally.

Frequently Asked Questions about lcp-mintlify-docs

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

FAQPage Schema
How do I validate Mintlify docs navigation and keep docs.json in sync?

To validate Mintlify docs navigation, you can run the local validation script docs/scripts/check-docs-json.mjs. This enforces synchronization between your docs.json configuration and the actual page structure to ensure navigation consistency.

What is the best way to check for broken links in Mintlify documentation?

The best way to check for broken links in Mintlify documentation is to execute the check-docs-json.mjs script. It runs integrity checks to catch invalid references and prevent link issues in production docs.

How do I run accessibility checks on my Mintlify docs site?

You can run accessibility checks on your Mintlify docs site by executing the local validation script. This process performs a11y validation to catch accessibility issues early before deploying documentation updates.

Why does my Mintlify docs navigation show pages that are missing from the directory?

Mintlify docs navigation shows missing pages when docs.json and the actual docs structure are out of sync. You need to update the site configuration to enforce synchronization between the navigation file and the pages.

Do I need a specific environment to run Mintlify documentation validation scripts?

You need a local environment capable of executing .mjs JavaScript modules to run the Mintlify documentation validation scripts. The validation process requires running check-docs-json.mjs locally to verify structure and accessibility.