review-doc-style

Solid

Review documentation, examples, and docs-heavy changes for NVIDIA technical writing style, terminology, and repo accuracy

AI & Automation 122 stars 57 forks Updated today Apache-2.0

Install

View on GitHub

Quality Score: 86/100

Stars 20%
70
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# 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 1. Identify the changed docs, examples, or public-facing strings. 2. Confirm the described behavior is still true in the current repo. 3. Check whether entry-point docs also need updates: - `README.md` - `docs/index.md` - Package or crate READMEs - Binding-level source READMEs such as `python/nemo_relay/README.md` or `crates/core/README.md` 4. Start with `assets/nvidia-style-guide.md`, then open only the focused support document needed for the issue under review. 5. Scan for high-signal style issues in headings, links, code formatting, terminology, procedures, and plain-English readability. 6. Report findings in severity order with file references and concrete...

Details

Author
NVIDIA
Repository
NVIDIA/NeMo-Relay
Created
4 months ago
Last Updated
today
Language
Rust
License
Apache-2.0

Integrates with

Similar Skills

Semantically similar based on skill content — not just same category