Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

docs(skills): split documentation workflows#113

Open
ayushag-nv wants to merge 1 commit into
mainNVIDIA-NeMo/Switchyard:mainfrom
ayushag/switch-1008-evaluate-nvidia-docs-skills-for-switchyard-documentationNVIDIA-NeMo/Switchyard:ayushag/switch-1008-evaluate-nvidia-docs-skills-for-switchyard-documentationCopy head branch name to clipboard
Open

docs(skills): split documentation workflows#113
ayushag-nv wants to merge 1 commit into
mainNVIDIA-NeMo/Switchyard:mainfrom
ayushag/switch-1008-evaluate-nvidia-docs-skills-for-switchyard-documentationNVIDIA-NeMo/Switchyard:ayushag/switch-1008-evaluate-nvidia-docs-skills-for-switchyard-documentationCopy head branch name to clipboard

Conversation

@ayushag-nv

@ayushag-nv ayushag-nv commented Jul 22, 2026

Copy link
Copy Markdown
Contributor

Why

The existing switchyard-docs skill combines durable MkDocs policy with drafting, editing, and review concerns. Splitting those workflows makes skill selection more precise while keeping repository-specific documentation rules scoped to the documentation tree.

What

  • Move Switchyard's MkDocs, publishing, accuracy, and CI rules into docs/AGENTS.md.
  • Add dedicated skills for drafting, polishing, example auditing, novice review, and pragmatist review.
  • Remove the superseded all-purpose switchyard-docs skill.
  • Exclude docs/AGENTS.md from the published MkDocs site and document the new skill entry points in the root guidance.

How

The new skills adapt the corresponding NVIDIA Tech Docs workflows under Apache-2.0. Adaptations are limited to repository-local names, standalone operation without DORI/plugin-runtime dependencies, and loading the scoped documentation guidance. Generic evidence-source guidance remains generic.

Where to Start Review

Start with docs/AGENTS.md, then review the five .agents/skills/switchyard-docs-*/SKILL.md files and the discovery list in AGENTS.md.

Test Plan

  • Five skill structural validations
  • Frontmatter parsing and unique skill-name check across all repository skills
  • Scan for stale switchyard-docs and DORI/plugin-runtime references
  • git diff --check
  • cd docs && make publish

All listed checks pass. The validation selector referenced by switchyard-testing-ci is absent on current main, so the documented direct gates were run instead.

Summary by CodeRabbit

  • Documentation
    • Added documentation contribution guidelines covering authoring, review, validation, publishing, and security practices.
    • Added specialized workflows for drafting, polishing, auditing, and reviewing documentation.
    • Updated project guidance to reference the new documentation workflows.
    • Excluded internal contributor guidance from the published documentation site.
  • Chores
    • Removed outdated documentation workflow instructions.

@github-actions

Copy link
Copy Markdown
PR Preview Action v1.8.1

🚀 View preview at
https://NVIDIA-NeMo.github.io/Switchyard/pr-preview/pr-113/

Built to branch gh-pages at 2026-07-22 08:49 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

@ayushag-nv
ayushag-nv marked this pull request as ready for review July 22, 2026 15:44
@ayushag-nv
ayushag-nv requested a review from a team as a code owner July 22, 2026 15:44
@coderabbitai

coderabbitai Bot commented Jul 22, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 9be7e553-8512-4f35-9e08-340e8aac4ad4

📥 Commits

Reviewing files that changed from the base of the PR and between e09b5b0 and 74a1cd1.

📒 Files selected for processing (9)
  • .agents/skills/switchyard-docs-draft/SKILL.md
  • .agents/skills/switchyard-docs-example-audit/SKILL.md
  • .agents/skills/switchyard-docs-novice-review/SKILL.md
  • .agents/skills/switchyard-docs-polish/SKILL.md
  • .agents/skills/switchyard-docs-pragmatist-review/SKILL.md
  • .agents/skills/switchyard-docs/SKILL.md
  • AGENTS.md
  • docs/AGENTS.md
  • mkdocs.yml
💤 Files with no reviewable changes (1)
  • .agents/skills/switchyard-docs/SKILL.md

Walkthrough

The change replaces one consolidated documentation skill with five specialized skills, adds repository and docs-specific guidance, registers the new workflows in AGENTS.md, and excludes AGENTS.md from the MkDocs site.

Changes

Documentation Workflow Reorganization

Layer / File(s) Summary
Specialized documentation skills
.agents/skills/switchyard-docs-*/SKILL.md
Adds drafting, polishing, example-audit, novice-review, and pragmatist-review workflows, while removing the previous consolidated skill.
Documentation guidance and discovery
AGENTS.md, docs/AGENTS.md
Registers the specialized workflows and defines documentation scope, validation, accuracy, publishing, and CI rules.
Internal guidance exclusion
mkdocs.yml
Adds AGENTS.md to MkDocs exclusions.

Estimated code review effort: 3 (Moderate) | ~20 minutes

Poem

I’m a bunny with docs in my paws,
Five new skills hop past old laws.
Strict builds sparkle, links align,
AGENTS stays out of the site line.
Thump, thump—clean guidance shines!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: splitting the documentation workflow into scoped skills.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 Checkov (3.3.8)
mkdocs.yml

Traceback (most recent call last):
File "/usr/local/bin/checkov", line 2, in
from checkov.main import Checkov
ModuleNotFoundError: No module named 'checkov'


Comment @coderabbitai help to get the list of available commands.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

Morty Proxy This is a proxified and sanitized view of the page, visit original site.