Index of every page on this site: llms.txt
All skills
nvidia-nemo avatar

/switchyard-docs

@c2f87c2
by nvidia-nemonvidia-nemo/switchyard3.7k stars
378
Run it yourself

Edit or debug the published Switchyard MkDocs site. Use for docs pages, mkdocs.yml navigation, mkdocs_hooks.py source links, strict build failures, local previews, or .github/workflows/docs.yml.

Use this Skill: https://skilld.dev/gh/nvidia-nemo/switchyard/switchyard-docs

Nothing lands on disk. Nothing to clean up.

Fork this Skill

Edit a local copy. It keeps the author and licence.

SKILL.md

≈53 tokens for metadata: the name and description. ≈396 when used: this file.

Description uses 2.6% of example budget

Before choosing a Skill, your Agent reads its name and description. All available Skills share that space.

  • A shorter description leaves more room for other Skills. This entry exceeds our 1% size suggestion.

In our Claude Code example, all Skill names and descriptions share 8,000 characters. This Skill uses ≈212 characters, or 2.6%.

The 1% threshold is a size suggestion. Longer descriptions can still fit.

Your model, settings, and other Skills decide how much text your Agent can read.

Example settings and source

The example uses a 200k-token context and default Claude Code settings. The count includes the name, description, separators, and when_to_use when present. Codex also counts local file paths.

Skit's source and limits: Codex 0.160.1, Claude Code 2.1.292.

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.

Source: SKILL.md on GitHub

skilld matched fixed text patterns in SKILL.md and file names. Patterns miss obfuscated code.

skilld run checks every file with the same patterns. It asks for approval before it loads a Skill with a behavior marked Needs approval.

No alerts4mo3 checks · Risk SAFE
  • Gen Agent Trust Hub4mo

    The skill provides comprehensive instructions for managing a MkDocs-based documentation site, including build commands, directory structure, and CI/CD best practices. It correctly emphasizes security by recommending against risky GitHub Actions configurations like `pull_request_target`. No security vulnerabilities or malicious patterns were identified.

  • Socket4mo

    No alerts

  • Snyk4mo

    Risk: LOW · No issues

Signed by skilld at c2f87c2. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub yesterday.

Activeupdated 4 months ago

README badge

README badge for nvidia-nemo/switchyard/switchyard-docs