agentleFS
Sign inStart free
ByronScottJonesByronScottJones/Agents/skills/validate-documentation/SKILL.md

validate-documentation

Skill7 starsChanged 2 months agoMITView on GitHub

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.

The file

We split this skill into the rules it gives an agent

7 rules. About 0 are common, 7 are distinctive, and 0 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈7

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 0

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Check documentation integrity across the repository and its agent guidance.

    line 9
  2. Distinctive:

    Run configured Markdown lint and detect frontmatter errors.

    line 24
  3. Distinctive:

    Verify local links, referenced files, anchors, code fences, commands, and paths.

    line 25
  4. Distinctive:

    Check reusable topic files are routed from AGENTS.md.

    line 26
  5. Distinctive:

    Do not rewrite documentation wholesale.

    line 32
  6. Distinctive:

    Do not weaken lint configuration to hide content errors.

    line 33
  7. Distinctive:

    Do not execute commands copied from documentation without confirmation.

    line 34

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

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.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free