Skip to content

donaldfilimon/abi / .agents/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.shexecutablescript2.7 KB

validate.sh

View on GitHub
#!/usr/bin/env bash
# docs-validate — validate the Mintlify docs site (docs/docs.json + docs/**/*.mdx).
#
# This is the one surface `./tools/check.sh` intentionally omits. There is no
# separate docs-validate CI job in the current workflow. Run this as a
# pre-push gate after touching docs/. Requires network (npx fetches mint).
set -uo pipefail

SCRIPT_PATH=$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")" && pwd)/$(basename -- "${BASH_SOURCE[0]}")

cd "$(git rev-parse --show-toplevel 2>/dev/null)" 2>/dev/null || {
  echo "RESULT: FAIL (run from inside the abi repo)"; exit 1; }

# Mintlify config lives under docs/.
if [ -f docs/docs.json ]; then cd docs
else echo "RESULT: FAIL (no docs/docs.json found — is this the abi repo?)"; exit 1; fi

command -v npx >/dev/null 2>&1 || { echo "RESULT: FAIL (npx not on PATH — install Node/npm)"; exit 1; }

# mintlify requires an LTS node and hard-fails on node 25+. Detect early and give
# an actionable message instead of a confusing validator error (this is an env
# issue, not a docs problem).
node_major="$(node -v 2>/dev/null | sed 's/^v//; s/[.].*//')"
if [ -n "$node_major" ] && [ "$node_major" -ge 25 ] 2>/dev/null; then
  fallback_node_bin="${ABI_DOCS_VALIDATE_NODE_BIN:-$HOME/.cache/codex-runtimes/codex-primary-runtime/dependencies/node/bin}"
  fallback_node="$fallback_node_bin/node"
  if [ "${ABI_DOCS_VALIDATE_NODE_FALLBACK:-0}" != "1" ] && [ -x "$fallback_node" ]; then
    fallback_major="$("$fallback_node" -v 2>/dev/null | sed 's/^v//; s/[.].*//')"
    if [ -n "$fallback_major" ] && [ "$fallback_major" -lt 25 ] 2>/dev/null; then
      echo "node $(node -v) unsupported; retrying with bundled node $("$fallback_node" -v)."
      PATH="$fallback_node_bin:$PATH" ABI_DOCS_VALIDATE_NODE_FALLBACK=1 exec "$SCRIPT_PATH" "$@"
    fi
  fi
  echo "RESULT: SKIP (node $(node -v) unsupported — mintlify needs an LTS node, fails on 25+)."
  echo "  Select an LTS node (nvm/fnm) and re-run; this is not a docs error."
  exit 3
fi

echo "[1/2] mint validate (config + pages) in $(pwd) ..."
if npx --yes mint@latest validate; then
  vfail=0
else
  vfail=1
fi

# Extra guard: catch the .md->.mdx link rot that bit PR #651 — internal links or
# nav entries pointing at .md files that no longer exist after the Mintlify cutover.
echo "[2/2] scanning for stale .md references in nav/pages ..."
stale="$(grep -rInE '"[^"]+\.md"|\]\([^)]+\.md[)#]' docs.json ./*.mdx 2>/dev/null | grep -v '\.mdx' || true)"
if [ -n "$stale" ]; then
  echo "  ! possible stale .md references (verify these still resolve):"
  printf '%s\n' "$stale" | sed 's/^/    /'
fi

if [ "$vfail" -eq 0 ]; then
  echo "RESULT: PASS — Mintlify config + pages valid"
  exit 0
fi
echo "RESULT: FAIL — see 'mint validate' output above"
exit 1
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: 471kUpdated 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