mags-docs-validate

Validate project documentation frontmatter, cross-references, and ADR structure.

3|Updated Feb 2, 2026
One-click install
npx skills add https://github.com/doancan/mags --skill mags-docs-validate
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: mags-docs-validate
Source: https://github.com/doancan/mags/tree/main/skills/mags-docs-validate
Command: npx skills add https://github.com/doancan/mags --skill mags-docs-validate

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation drift and inconsistent metadata slow teams and erode trust in project knowledge. mags-docs-validate performs automated checks to ensure docs include required frontmatter, valid cross-references, and proper ADR/memory-doc structure.

Core Features & Use Cases

  • Standard validation checks frontmatter, references, and freshness
  • Deep validation includes version conflicts, memory-doc consistency, ADR structure validation, and module completeness checks
  • Results are grouped by severity and surfaced for remediation; integration with mags_get_doc and mags_update_doc to fix issues

Quick Start

Run /mags-docs-validate in your project to begin a standard validation pass.

Frequently Asked Questions about mags-docs-validate

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

FAQPage Schema
How do I validate project documentation for consistency and broken cross-references?

Deep documentation validation detects version conflicts and checks memory-doc consistency across modules. It performs standard checks for frontmatter, references, and freshness, then escalates to structural validation for ADRs and module completeness when needed.

How do I check ADR structure and memory-doc consistency across project modules?

Deep documentation validation detects version conflicts and checks memory-doc consistency across modules. It performs standard checks for frontmatter, references, and freshness, then escalates to structural validation for ADRs and module completeness when needed.

What's the best way to fix documentation issues found during a validation pass?

Deep validation extends standard checks by detecting version conflicts in documentation. It verifies memory-doc consistency across modules, validates ADR structure, and checks module completeness, returning severity-grouped results to pinpoint exact remediation targets.

Why does documentation validation report version conflicts in my project docs?

Deep validation extends standard checks by detecting version conflicts in documentation. It verifies memory-doc consistency across modules, validates ADR structure, and checks module completeness, returning severity-grouped results to pinpoint exact remediation targets.

Do I need any dependencies to run frontmatter and cross-reference checks on my docs?

Documentation validation groups results by severity to prioritize remediation of inconsistencies. It surfaces failed frontmatter checks, broken cross-references, and ADR structural errors, allowing targeted fixes via mags_get_doc and mags_update_doc.