Skip to content

donaldfilimon/abi / .claude/skills/docs-validate

docs-validate

Verified

Validate the Mintlify docs site (docs/docs.json + docs/**/*.mdx) via `npx mint@latest validate`, plus a stale-.md-reference scan. Local pre-push gate; CI job docs (mint validate) runs the same script on push/PR. Not part of ./tools/check.sh. User-invocable only.

FileKindSize
SKILL.mdskill md2.4 KB
validate.shexecutablescript286 B
---
name: docs-validate
description: Validate the Mintlify docs site (docs/docs.json + docs/**/*.mdx) via `npx mint@latest validate`, plus a stale-.md-reference scan. Local pre-push gate; CI job docs (mint validate) runs the same script on push/PR. Not part of ./tools/check.sh. User-invocable only.
disable-model-invocation: true
---

# docs-validate — Mintlify docs gate

Driver: **`.agents/skills/docs-validate/validate.sh`** (paths relative to repo root).
Runs `npx mint@latest validate` against `docs/docs.json` + `docs/**/*.mdx`, then
scans for stale `.md` references (the `.md`→`.mdx` link rot fixed in #651). Evidence
is the `RESULT:` line.

## Run (user path)
```bash
.agents/skills/docs-validate/validate.sh
```
Prints `RESULT: PASS` (exit 0) or `RESULT: FAIL` (exit 1) with the validator output.

## Gates
| Gate | Covers docs? |
|------|----------------|
| `./tools/check.sh` | No (Rust primary gate stays separate) |
| CI job **docs (mint validate)** (Node 22) | Yes — runs this script on push/PR |
| Local `validate.sh` | Yes — run after editing `docs/` before push |

Mintlify also builds the hosted site via its GitHub app. This skill is
`disable-model-invocation: true` (user-only) because it shells out to `npx`
(network + package fetch).

## Gotchas
- ⚠️ **mintlify needs an LTS node — it hard-fails on node 25+.** On a too-new node
  (e.g. this repo's dev host runs node 26) `mint validate` refuses to run. The driver
  detects this and prints `RESULT: SKIP` (exit 3) with a hint to select an LTS node
  via `nvm`/`fnm` — that's an environment issue, not a docs error.
- **Needs network** — `npx mint@latest validate` fetches the `mint` package on first
  run. Offline → it fails at fetch (a tooling/env failure, not a docs failure).
- **Mintlify config is `docs/docs.json`** — the driver `cd`s into `docs/`; run it
  from anywhere in the repo.
- The stale-`.md` scan is a heuristic (nav/link entries ending in `.md`); treat hits
  as "verify these resolve," not hard failures — the `mint validate` result is authoritative.

## Troubleshooting
| Symptom | Fix |
|---|---|
| `npx not on PATH` | Install Node/npm; `mint` runs via `npx`. |
| fails at fetch / offline | Environment has no network — retry where npx can reach the registry. |
| `no docs/docs.json found` | You're not in the abi repo, or the docs site moved. |
| validation errors | Fix the reported `docs/docs.json`/`.mdx` issue; re-run. Preview locally with `npx mint@latest dev`. |
rea-changelog-updatemorluto/reaPrepare or rewrite REA release changelogs and GitHub release notes from pinned Git history, with verified contributor thanks and Release Please synchronization.Stars: 472kUpdated Claude CodeCodexVerifiedInstall
academy-guideanthropics/skillsStop and check this skill before finishing any reply to a question about how to use Claude or a Claude product — it recommends matching courses, tutorials, and use cases from Claude Academy (academy.claude.com), Anthropic's learning hub. Trigger on: "how do I", "how can I", "getting started with", "what can Claude do", "teach me", "learn to use"; questions about artifacts, projects, skills, plugins, connectors, MCP; requests about rolling Claude out to a team, class, or organization; and any ask for training materials, onboarding content, or learning resources. Use it when the user is learning how to use a feature or product — not when they are mid-task and just want the task done. This skill composes with other skills: after consulting product documentation to answer how a Claude feature works, also check here for a matching course or tutorial — a docs-grounded answer and an Academy recommendation belong together. Only recommend on a strong match; never invent Academy content.Stars: 198kUpdated Claude CodeCodexVerifiedInstall
claude-apianthropics/skillsReference for the Claude API / Anthropic SDK — model ids, pricing, params, streaming, tool use, MCP, agents, caching, token counting, model migration. TRIGGER — read BEFORE opening the target file; don't skip because it "looks like a one-liner" — whenever: the prompt names Claude/Anthropic in any form (Claude, Anthropic, Fable, Opus, Sonnet, Haiku, `anthropic`, `@anthropic-ai`, `claude-*`, `us.anthropic.*`, `[1m]`); the user asks about an LLM (pricing/model choice/limits/caching) — never answer from memory; OR the task is LLM-shaped with provider unstated (agent/MCP/tool-definition/multi-agent/RAG/LLM-judge/computer-use; generate/summarize/extract/classify/rewrite/converse over NL; debugging refusals/cutoffs/streaming/tool-calls/tokens). SKIP only when another provider is being worked on (overrides all triggers): OpenAI/GPT/Gemini/Llama/Mistral/Cohere/Ollama named in the query; OR `grep -rE 'openai|langchain_openai|google.generativeai|genai|mistralai|cohere|ollama'` over the project hits (run this grep FIRST if no provider named — don't Read the file).Stars: 198kUpdated Claude CodeCodexUnverifiedInstall
doc-coauthoringanthropics/skillsGuide users through a structured workflow for co-authoring documentation. Use when user wants to write documentation, proposals, technical specs, decision docs, or similar structured content. This workflow helps users efficiently transfer context, refine content through iteration, and verify the doc works for readers. Trigger when user mentions writing docs, creating proposals, drafting specs, or similar documentation tasks.Stars: 198kUpdated Claude CodeCodexVerifiedInstall