Skip to content
Back to skills

Claude Docs Validate

ASecurity

Check the health and freshness of locally-stored Claude documentation. Use this skill when the user asks about documentation health, broken links, stale docs, freshness checks, or wants to validate that their local install is up-to-date and all URLs are reachable. Triggers on: "are my docs current", "check doc health", "validate documentation", "broken links", "stale docs".

  • 54 stars
  • 0 votes
  • 0 copies
  • 3 views
  • Added August 30, 2026
ai-agentsgobashgitdocumentation

Works with

  • claude code

Security analysis

A100/100

Pro scans all 3 files and shows the line behind each finding

Scanned August 30, 2026

npx -y skills add costiash/claude-code-docs --skill claude-docs-validate --agent claude-code

Installs into .claude/skills of the current project.

Are you the author of Claude Docs Validate?

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

Security grade badge for Claude Docs Validate
[![Security: A — Skills Directory](https://www.skillsdirectory.com/api/skills/costiash-claude-docs-validate/badge)](https://www.skillsdirectory.com/skills/costiash-claude-docs-validate)

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: claude-docs-validate
description: >
  Check the health and freshness of locally-stored Claude documentation.
  Use this skill when the user asks about documentation health, broken links,
  stale docs, freshness checks, or wants to validate that their local install
  is up-to-date and all URLs are reachable. Triggers on: "are my docs current",
  "check doc health", "validate documentation", "broken links", "stale docs".
---

# Claude Documentation Validation Skill

Check whether the local documentation clone at `~/.claude-code-docs/` is healthy and up-to-date.

## When to Use This Skill

Activate when the user asks about:
- Documentation freshness or staleness
- Broken links or unreachable docs
- Health checks on their local install
- Whether docs need updating

## Validation Workflow

### Step 1: Check if the metadata is installed

Verify `~/.claude-code-docs/paths_manifest.json` exists. If not:
> Documentation not found. Run this in Claude Code to install:
> ```
> /plugin marketplace add costiash/claude-code-docs
> /plugin install claude-docs@claude-code-docs
> ```

### Step 2: Check freshness

Two signals — when the manifest was last generated (server-side), and when the clone last pulled:
```bash
jq -r '.generated_at' ~/.claude-code-docs/paths_manifest.json          # manifest build time
cd ~/.claude-code-docs && git log -1 --format="%ci %s"                  # clone last updated
```
If the manifest is older than ~24h, the SessionStart hook normally refreshes it on the next
session; a manual refresh is `cd ~/.claude-code-docs && git fetch origin main && git reset --hard origin/main`.

### Step 3: Check the cache status

```bash
~/.claude-code-docs/plugin/scripts/fetch-docs.sh status
```
Reports manifest pages / cached / pending / stale. If pending > 0, suggest `/docs sync`.

### Step 4: Run URL validation (if user asks for it)

Quick spot-check (recommended first), or full scan (1-2 min):
```bash
bash ~/.claude-code-docs/plugin/skills/claude-docs-validate/scripts/validate-paths.sh --quick
bash ~/.claude-code-docs/plugin/skills/claude-docs-validate/scripts/validate-paths.sh
```
These read URLs directly from the manifest. Report the summary (reachable / broken / timed out).
For persistent broken URLs, the upstream page may have moved — report at
https://github.com/costiash/claude-code-docs/issues.

### Step 5: Doc statistics (if user asks for stats/count)

```bash
jq '.pages | length' ~/.claude-code-docs/paths_manifest.json                       # total
jq -r '.pages[].category' ~/.claude-code-docs/paths_manifest.json | sort | uniq -c | sort -rn  # by category
```

## Troubleshooting

| Issue | Solution |
|---|---|
| "Documentation not found" | Plugin not installed or docs not cloned. Re-run `/plugin install claude-docs@claude-code-docs` |
| Many broken URLs | Likely a sitemap change. Run `git pull` first, then re-validate |
| Timeout errors | Network issue or Anthropic site is slow. Try again later |
| "Permission denied" | Check that `~/.claude-code-docs/` is readable |

## Reference Files

- `examples/validate-docs.md` — Example validation workflow

Files in this skill

  • SKILL.md3.1 KB
  • examples/validate-docs.md1.7 KB
  • scripts/validate-paths.sh4.1 KB

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.