Review Documentation Style
Prioritize factual accuracy over copy polish. Confirm commands, package names,
APIs, paths, supported bindings, and public behavior against the current
repository before reporting style findings.
Review Flow
- Identify the changed documentation, examples, or public strings and any
corresponding entry points such as
README.md, docs/index.yml, or package
READMEs.
- Read
references/nvidia-style-guide.md for the fast-path checklist and
severity model.
- Open only the focused reference that resolves an actual ambiguity:
references/nvidia-style-technical-docs.md for structure, procedures,
examples, links, tables, UI text, or accessibility.references/nvidia-style-language-mechanics.md for voice, grammar,
punctuation, dates, numbers, units, or plain English.references/nvidia-style-brand-terminology.md for NVIDIA and product
names, trademarks, acronyms, legal copy, or SEO.
- Verify MDX files use JSX delimiters for top-of-file SPDX comments.
- Report findings in severity order with a file and line, reader impact, and a
concrete rewrite or direction. Omit preference-only findings unless the user
requested a deep copyedit.
If no issues are found, say so and identify any commands or examples that were
not executed.
References
CONTRIBUTING.mdreferences/nvidia-style-guide.md- Open only the focused NVIDIA style reference selected in step 3.
1---2name: review-doc-style-23description: Review NeMo Relay documentation, examples, or public text for NVIDIA technical writing style, terminology, and repository accuracy. Do not use for ordinary implementation review.4license: Apache-2.05---67# Review Documentation Style89Prioritize factual accuracy over copy polish. Confirm commands, package names,10APIs, paths, supported bindings, and public behavior against the current11repository before reporting style findings.1213## Review Flow14151. Identify the changed documentation, examples, or public strings and any16 corresponding entry points such as `README.md`, `docs/index.yml`, or package17 READMEs.182. Read `references/nvidia-style-guide.md` for the fast-path checklist and19 severity model.203. Open only the focused reference that resolves an actual ambiguity:21 - `references/nvidia-style-technical-docs.md` for structure, procedures,22 examples, links, tables, UI text, or accessibility.23 - `references/nvidia-style-language-mechanics.md` for voice, grammar,24 punctuation, dates, numbers, units, or plain English.25 - `references/nvidia-style-brand-terminology.md` for NVIDIA and product26 names, trademarks, acronyms, legal copy, or SEO.274. Verify MDX files use JSX delimiters for top-of-file SPDX comments.285. Report findings in severity order with a file and line, reader impact, and a29 concrete rewrite or direction. Omit preference-only findings unless the user30 requested a deep copyedit.3132If no issues are found, say so and identify any commands or examples that were33not executed.3435## References3637- `CONTRIBUTING.md`38- `references/nvidia-style-guide.md`39- Open only the focused NVIDIA style reference selected in step 3.
NVIDIA