run-documentation-examples

Extract Python examples from markdown docs and run them (including LLM examples). Use when validating documentation, after doc changes, or to verify all doc examples execute correctly.

1.51x

Quality

82%

Does it follow best practices?

Impact

100%

1.51x

Average score across 3 eval scenarios

Securityby

Passed

No known issues

Evaluation results

100%

48%

Validate Documentation Examples in CI

CI doc-example validation with Ollama skip

Criteria

Without context

With context

Pytest invocation

100%

Verbose flag

100%

Uses .venv Python

100%

Does not use system python

100%

Ollama skip marker

100%

Run from project root

50%

100%

Results summary command

100%

Results summary outcome

100%

Shell script exists

100%

Resume a Partially Failed Documentation Example Run

CLI runner failure resume mechanism

Criteria

Without context

With context

Fail index filename

100%

Fail index content

100%

Exits on first failure

100%

Resume by re-running

100%

Reset by deleting

100%

Extracted examples file

100%

CLI command used

100%

Uses .venv

100%

Does not use system python

100%

52%

Set Up talkpipe Documentation Example Runner with LLM Support

LLM extras setup and manual two-step run

Criteria

Without context

With context

Extras installation

100%

Correct pip extras syntax

100%

ollama serve

100%

llama3.2 model pull

100%

Embedding model pull

100%

OpenAI env var

100%

Two-step: extract script

100%

Two-step: run extracted

100%

Uses .venv

100%

Repository: sandialabs/talkpipe
Commit: 0cf1686

Evaluated: 22 days ago
Agent: Claude Code
Model: Claude Sonnet 4.6

Table of Contents

Validate Documentation Examples in CI Resume a Partially Failed Documentation Example Run Set Up talkpipe Documentation Example Runner with LLM Support

Is this your skill?

If you maintain this skill, you can claim it as your own. Once claimed, you can manage eval scenarios, bundle related skills, attach documentation or rules, and ensure cross-agent compatibility.