Skip to content

/claude-docs-validate

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:

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

How it fires

How this skill gets triggered: by you, by Claude, or both.

  • Fires itselfAuto-invocation. Claude auto-loads it when your prompt matches the work.
  • You can call itInvoke it directly when you want it.
  • Slash command/claude-docs-validate
How auto-invocation works

Context preview

The summary Claude sees to decide when to auto-load this skill.

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:

SKILL.md

claude-docs-validate.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:

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

~/.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 ~/.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)

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
Read more
Read it on GitHub ↗
Ships withclaude-code-docs

Official Claude docs, always up-to-date, always at your fingertips. Stop searching the web — ask Claude directly and get accurate answers grounded in official documentation.

Get the whole plugin, auto-invoked
Stats
50
Stars
0
Views
6
Forks
Active
Maintenance
Python
Language
17h ago
Last commit
9mo ago
Created

Repo: costiash/claude-code-docs