v2-docs-audit

Scan MDX docs against the v2 transaction tracker and surface coverage gaps.

Updated May 27, 2025
One-click install
npx skills add https://github.com/Andamio-Platform/andamio-docs --skill v2-docs-audit
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: v2-docs-audit
Source: https://github.com/Andamio-Platform/andamio-docs/tree/main/.claude/skills/v2-docs-audit
Command: npx skills add https://github.com/Andamio-Platform/andamio-docs --skill v2-docs-audit

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill acts as the documentation manager for V2 transaction MDX files in content/docs/protocol/v2/transactions/. It tracks coverage, flags gaps, and coordinates review workflows to keep documentation aligned with the API.

Core Features & Use Cases

  • Coverage scanning: scans the MDX docs directory and compares against the v2 transaction tracker to surface missing or outdated docs.
  • Dashboard & reporting: presents a summary of documented, missing, and misaligned docs, plus per-transaction statuses.
  • Actionable guidance: suggests migrations, content reviews, and stub creation to restore full coverage.

Quick Start

Run the v2-docs-audit command to generate the dashboard and review pending tasks.

Frequently Asked Questions about v2-docs-audit

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

FAQPage Schema
How do I track MDX documentation coverage for V2 API transactions?

To track MDX documentation coverage for V2 API transactions, you can run a workflow that scans the docs directory and compares it against a transaction tracker to surface missing or outdated files.

What is path-alignment in V2 MDX documentation?

Path-alignment in V2 MDX documentation ensures that MDX files, YAML sources, and the documentation tracker accurately match the current API endpoints.

How do I identify missing MDX files in a V2 transactions directory?

You identify missing MDX files by applying an audit workflow that scans the V2 transactions directory and compares the results against a transaction tracker to flag undocumented endpoints.

Can I generate a dashboard for MDX documentation gaps?

Yes, you can generate a coverage dashboard that presents a summary of documented, missing, and misaligned V2 transaction docs, along with per-transaction statuses.

What actions should I take to fix outdated V2 MDX docs?

To fix outdated V2 MDX docs, the audit workflow proposes necessary actions for content review, stub creation, or migration to restore full coverage and alignment.