v2-docs-review

Review V2 transaction MDX documentation against YAML sources for accuracy.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill reviews individual V2 transaction MDX documentation for coverage and accuracy, ensuring it aligns with the analyzed YAML sources and supports reliable documentation governance.

Core Features & Use Cases

  • Automated comparison: Validates MDX content against YAML data and flags gaps.
  • Discrepancy reporting: Generates a structured report detailing what is correct, missing, and incorrect.
  • Workflow integration: Works with the /v2-docs-audit orchestrator to track coverage and drive fixes.

Quick Start

Invoke the skill to review a transaction, for example: /v2-docs-review <transaction.id>. The tool will generate a findings report and suggested fixes.

Frequently Asked Questions about v2-docs-review

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

FAQPage Schema
How do I audit MDX files against YAML source data for documentation accuracy?

To audit MDX files against YAML source data, you can review v2 transaction documentation to validate coverage and accuracy, ensuring alignment of costs, endpoints, inputs, outputs, and notes across both datasets.

What is the best way to ensure v2 transaction docs align with YAML sources?

The best way to ensure v2 transaction docs align with YAML sources is to enforce adherence to the YAML source of truth, automatically compare MDX content against it, and generate a structured report detailing missing or incorrect data.

How do I generate a report for missing or incorrect transaction documentation?

You can generate a report for missing or incorrect transaction documentation by invoking a review of a specific transaction ID, which produces a findings report detailing what is correct, missing, and incorrect, plus actionable fixes.

Can I track documentation coverage and drive fixes for v2 MDX files?

Yes, you can track documentation coverage and drive fixes for v2 MDX files by integrating the review process with an audit orchestrator that tracks coverage gaps and supports reliable documentation governance.

What does a v2 docs review check for in transaction MDX files?

A v2 docs review checks transaction MDX files for coverage and accuracy, specifically validating alignment of costs, endpoints, inputs, outputs, and notes against the analyzed YAML source data.

When should I use an automated comparison for MDX and YAML datasets?

You should use an automated comparison for MDX and YAML datasets when you need to flag gaps in individual V2 transaction documentation and enforce adherence to the YAML source of truth for reliable governance.