Agent skill · supabase
test-the-docs
Execute runnable docs snippets and examples inside a disposable Docker Compose sandbox (runner container + local Supabase stack via `supabase start`). Use after Draft or during Self-review when asked to test the docs, fact-check CLI/SQL/code samples, or produce a verification report for a docs PR. Complements review-the-docs lint/build checks; does not replace them.
What it needs
About 3k tokens when loaded.
What this skill does
Test the docs Runs procedural docs content inside disposable containers, not on the host shell and not against production. Produces a verification report for the PR body / self-review note. For lint, markdown rebuilds, example-app triage, and PR review, use review-the-docs. For Frame/Shape and cross-repo product lookup, use pm-the-docs. When to invoke After Draft, before or during Self-review (checklist Stage 4). Standalone: "test the docs", "fact-check these snippets", "run the examples". Content or tutorial PRs that add or change procedural fenced blocks. Not for: generated reference pages, docs-app architecture questions, or hosted/production projects. Core rules 1. Never run against production. Local stack or temp dir only. 2. Never run MDX fences on the host shell. Use the Compose sandbox — see reference/sandbox-setup.md and sandbox/run.sh. 3. Proportional: Tier A (one end-to-end path) is required; Tier B spot-checks new/changed procedural blocks, not every fence on every page. 4. Product bugs found while testing get linked or filed separately; fix docs only when the docs are wrong. Phases 1. Scope From explicit MDX paths, or: Skip generated reference output under features/docs/generated/. 2. Extract List runnable artifacts from changed MDX: Fenced blocks: bash, sh, sql, javascript, typescript, tsx, jsx $CodeSample paths → treat as example-app (build under examples/) Skip: mermaid, incomplete illustrative fragments, partial-only includes 3. Classify Assign each artifact a class per reference/snippet-classes.md: Class Action --------------------- ---------------------------------------------- runnable-local Run in temp stack / temp dir runnable-with-setup Run after documented setup (migrations, seed) example-app npm install && npm run build in examples/… illustrative-only No run required deferred Record reason; do not silently skip 4. Sandbox setup Follow reference/sandbox-setup.md and drive lifecycle with sandbox/run.sh: 1. …
How to use it
Reference it in AdaL, Claude Code, Cursor or any coding agent — nothing to install:
@skills supabase/test-the-docs