switchyard-docs

A guide for editing and checking a documentation website built with MkDocs, a tool that turns Markdown files into a published site. It covers navigation, source links, local previews, and strict build checks.

In plain words
What is it for?
Use it to add or update documentation pages, change site navigation, preview the site, audit links, and run the required publishing build.
Why use it?
It explains where public pages belong and helps fix warnings that would otherwise fail continuous integration checks.

Skill for Claude CodeCodex

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add skills/nvidia-nemo/switchyard/switchyard-docs
Any agent
npx skills add NVIDIA-NeMo/Switchyard --skill switchyard-docs
Clone the repo
git clone --depth 1 https://github.com/NVIDIA-NeMo/Switchyard

Made for: Claude Code, Codex.

Per session 48 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 410 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00048 $0.00410
Opus 5 $0.00024 $0.00205
Sonnet 5 $0.00010 $0.00082
Haiku 4.5 $0.00005 $0.00041

Measured yesterday against content hash 9e7e77db9859, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

switchyard-docs scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured yesterday.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

.agents/skills/switchyard-docs/SKILL.md · 47 lines

What it actually says

Switchyard Documentation

The published site is the subset of docs/ selected by mkdocs.yml. Strict MkDocs warnings fail CI, so fix warnings rather than weakening validation.

Source Of Truth

Concern File
Navigation, exclusions, theme mkdocs.yml
Source-link rewriting mkdocs_hooks.py
Local commands docs/Makefile
Build, preview, deployment .github/workflows/docs.yml
Documentation dependencies pyproject.toml docs group

Workflow

  1. Decide whether a new page is public. Public pages go in nav; internal notes go in exclude_docs.
  2. Match the surrounding file naming and documentation style.
  3. Use relative links. For repository files outside docs/, use paths relative to the Markdown file and let mkdocs_hooks.py produce the source URL.
  4. Verify public examples use supported public imports and current CLI syntax.
  5. Run the strict build:
cd docs
make publish

CI Constraints

  • Keep the docs workflow path-filtered.
  • Keep default permissions read-only and grant write access only to deployment jobs.
  • Keep PR previews limited to same-repository pull requests.
  • Do not use pull_request_target to run untrusted documentation code with write permissions.
  • Build once and pass the site/ artifact to preview and deployment jobs.
  • Preserve keep_files: true so a main deployment does not remove PR previews.

Common strict-build fixes are direct: add or remove a missing nav entry, repair the relative link, or explicitly exclude an internal page. Do not disable strict mode.

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. yesterday First seen · 47 lines · 48 tokens per session scan A 9e7e77db9859

Subscribe to this mod's changes

switchyard-docs is a skill published in the GitHub repository NVIDIA-NeMo/Switchyard (2,588 stars, last pushed 3d ago), licensed Apache-2.0. It adds 48 tokens to every session and 410 once invoked, about $0.0002 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Related

Other skills, from other repositories

systematic-debugging

Use when encountering any bug, test failure, or unexpected behavior, before proposing fixes.

obra/superpowers · 21 tokens

next-cache-components-adoption

Turn on Cache Components in a Next.js app and resolve the blocking routes it surfaces. Use when the user wants to enable, adopt, or migrate to Cache Components, flip the cacheComponents flag, work through a flood of blocking-prerender / instant validation errors, run the cache-components-instant-false codemod, or…

vercel/next.js · 95 tokens

babysit-pr

Babysit a GitHub pull request after creation by continuously polling review comments, CI checks/workflow runs, and mergeability state until the PR is merged/closed or user help is required. Diagnose failures, retry likely flaky failures up to 3 times, auto-fix/push branch-related issues when appropriate, and keep…

openai/codex · 114 tokens

imagegen

Generate or edit raster images when the task benefits from AI-created bitmap visuals such as photos, illustrations, textures, sprites, mockups, or transparent-background cutouts. Use when Codex should create a brand-new image, transform an existing image, or derive visual variants from references, and the output…

openai/codex · 113 tokens

cpu-profile-analysis

Analyze V8/Chrome CPU profiles (.cpuprofile) and DevTools trace files (Trace-.json). Use when: profiling performance, investigating slow functions, comparing code paths, finding bottlenecks, analyzing timeToRequest, understanding call trees from sampling profiler data, analyzing layout/paint/rendering, investigating…

microsoft/vscode · 71 tokens

next-cache-components-optimizer

Drive a Next.js route to instant navigation by setting up an agentic loop, under Cache Components / PPR, on initial load (hard navigation) and client-side navigation (soft navigation). Encode the goal as a failing @next/playwright instant() e2e and work it to green, one verified route at a time; the shipped test then…

vercel/next.js · 170 tokens