| name | review-doc-style |
| description | Review documentation, examples, and docs-heavy changes for NVIDIA technical writing style, terminology, and repo accuracy |
| author | NVIDIA Corporation and Affiliates |
| license | Apache-2.0 |
Review Documentation Style
Companion Guidance
Use karpathy-guidelines alongside this skill for implementation or review
work. Keep changes scoped, surface assumptions, and define focused validation
before editing.
Use this skill when reviewing docs-only changes, example-heavy changes, or any
public-facing text update that should be checked against NVIDIA style guidance
and NeMo Relay repo conventions.
Review Priorities
- Prioritize factual accuracy over copy polish
- Flag stale commands, package names, APIs, bindings, repo paths, or support claims before stylistic issues
- Keep docs aligned with current NeMo Relay behavior, repo layout, and entry points
- Apply NVIDIA technical-writing guidance where it improves clarity and consistency without watering down technical precision
Review Flow
- Identify the changed docs, examples, or public-facing strings.
- Confirm the described behavior is still true in the current repo.
- Check whether entry-point docs also need updates:
README.mddocs/index.md- Package or crate READMEs
- Binding-level source READMEs such as or
