Skip to content
Back to skills

Validate Documentation

ASecurity

Use when auditing repository documentation for Markdown lint, broken links, stale paths, missing topic routing, invalid code fences, and inaccurate commands. Produces a report by default and only edits documentation with explicit confirmation.

  • 2 stars
  • 0 votes
  • 0 copies
  • 0 views
  • Added October 17, 2026
ai-agentsdocumentation

Security analysis

A100/100

Scanned October 17, 2026

npx -y skills add ByronScottJones/Agents --skill validate-documentation --agent claude-code

Installs into .claude/skills of the current project.

Are you the author of Validate Documentation?

Add the live security badge to your README. It updates with every re-scan.

Security grade badge for Validate Documentation
[![Security: A — Skills Directory](https://www.skillsdirectory.com/api/skills/byronscottjones-validate-documentation/badge)](https://www.skillsdirectory.com/skills/byronscottjones-validate-documentation)

More formats (shields.io, HTML) on the badges page. Keep it an A: scan every change in CI with Pro.

Download with Pro
SKILL.md
---
name: validate-documentation
user-invocable: false
description: "Use when auditing repository documentation for Markdown lint, broken links, stale paths, missing topic routing, invalid code fences, and inaccurate commands. Produces a report by default and only edits documentation with explicit confirmation."
---

# Validate Documentation

Check documentation integrity across the repository and its agent guidance.

## Parameters

- `rootPath`: repository root; default workspace root.
- `scope`: Markdown, agent guidance, README, or all; default all.
- `checkLinks`: default `true`.
- `checkCommands`: default `true`.
- `checkRouting`: default `true`.
- `fix`: default `false`.
- `format`: `summary`, `json`, or `sarif`; default `summary`.

## Workflow

1. Discover Markdown and agent customization files.
2. Run configured Markdown lint and detect frontmatter errors.
3. Verify local links, referenced files, anchors, code fences, commands, and paths.
4. Check reusable topic files are routed from `AGENTS.md`.
5. Identify duplicated ownership, contradictions, stale filenames, and unclear scope.
6. In fix mode, propose a diff first and apply only confirmed mechanical fixes.

## Safety

- Do not rewrite documentation wholesale.
- Do not weaken lint configuration to hide content errors.
- Do not execute commands copied from documentation without confirmation.

## Output

Return files checked, lint results, broken references, routing gaps, stale or
contradictory guidance, fixes proposed/applied, and remaining issues.

Attribution

Is this your skill, or is something wrong with this listing? Request removal or report an issue. Author removals are honored within 72 hours.

Comments

Loading comments…

Newsletter

Get the weekly list of safe new skills, and the ones we pulled.