snippet-verifylisted

Execute the code in your documentation and report which blocks actually run. Extracts every fenced snippet from a docs directory, README, MDX tree, or public docs URL, classifies each as runnable, credential-blocked, or illustrative, runs the runnable ones in a throwaway workspace against the versions you actually publish, and reports a pass rate with the real error for every failure. Use when asked whether the documentation still works, to verify code samples or quickstart steps, to check examples against a new release, before a launch, or when developers report that the docs do not run.
agentrel/skills · ★ 0 · AI & Automation · score 73

Install: claude install-skill agentrel/skills

# Snippet verify Every other check in this plugin produces a judgement. This one produces a fact: the number of documented code samples that execute, and the exact error for each one that does not. That number is not arguable, which is what makes it useful. A broken quickstart is the most expensive defect a developer product can ship, and it is invisible to code review because the code that broke lives in prose. ## Applies to | | | |---|---| | **Project types** | Anything documenting code — SDKs, APIs, CLIs, frameworks, libraries, developer platforms | | **Stage** | Any product with published examples. Highest value right after a major release, before a launch, and on a schedule thereafter — samples rot silently between releases | | **Needs** | Documentation containing fenced code blocks, plus a runtime for the languages used (`node`, `python`, `go`, `curl`) | | **Skip if** | The docs are conceptual only, with no executable samples. It will report that and stop rather than manufacture findings | Most valuable on the quickstart. A failing sample on page forty costs one reader; a failing sample on the first page costs every reader. ## How to use ``` /agentrel:snippet-verify verify this repository's docs /agentrel:snippet-verify ./docs/quickstart.mdx verify one page /agentrel:snippet-verify https://docs.acme.com verify a public docs site /agentrel:snippet-verify --lang python verify one language ``` Takes several minutes — depend