NeMo-RL Documentation Conventions
Keeps NeMo-RL documentation, indexes, and docstrings consistent.
The skill is limited to documentation and docstring guidance, with no credential access, network requirement, deletion, or external side effects, and it explicitly lists non-fit tasks; no red-line risk is visible. Three points are deducted because it does not specify user confirmation, rollback, data-flow disclosure, or sensitive-data handling, and its references and provenance are not backed by a detailed verification procedure.
The SKILL.md trigger metadata and three core rules are internally consistent, with reasonably clear paths and formatting requirements. Three points are deducted for missing handling and diagnostic feedback for abnormal inputs, missing indexes, ambiguous sections, or conflicting documentation; the benchmark is not treated as executed reproduction under static calibration, so the score stays below 10.
The audience, use cases, and exclusions are fairly clear in the front matter and skill-card.md, covering new documentation, documentation updates, and public-interface docstrings. Four points are deducted because semantic trigger priority, input/output boundaries, and non-fit cases for complex documentation structures are not specified, and there is no evidence of Chinese-language support; “Global” is only a deployment declaration.
The material includes front-matter metadata, an Apache-2.0 declaration, use-case information, risk notes, owner, evaluation date, and a version identifier, with readable organization. Six points are deducted because SKILL.md is very short and lacks recommended Instructions and Examples sections; FAQs, troubleshooting, known limitations, a formal changelog, and a clear maintenance/update path are absent, while repository license metadata is NOASSERTION.
The three positive evaluation tasks map directly to the stated rules, the core advice is directly usable for documentation maintenance, and the negative tasks define cases where activation should not occur. Nine points are deducted because BENCHMARK is a report of claimed metrics rather than independently reproducible execution evidence for this revision; representative real outputs, manual-comparison evidence, and completeness evidence for complex projects are limited.
The SKILL.md, evaluation-task definitions, benchmark report, and skill card provide traceability between the rules and expected behavior. Seven points are deducted because the reported percentages and PASS verdict lack attached logs, CI workflows, or a skill-specific committed test suite; static review cannot independently reproduce the execution conclusions, so only limited credit is warranted.
- Do not treat the benchmark PASS and percentages as independently reproduced validation for this revision; rerun positive, negative, and boundary-trigger evaluations before deployment.
- Add concrete examples, abnormal-case handling, known limitations, maintenance ownership, and a changelog, and clarify the relationship between the skill's license declaration and the repository's NOASSERTION metadata.
- This is a lightweight convention guide; complex documentation navigation, Sphinx configuration conflicts, and project-specific rules still require human review.
What does this skill do, and when should you use it?
This skill supports documentation maintenance for the NVIDIA NeMo-RL project. It requires docs/index.md to be updated when Markdown files are added or renamed, and recommends Google-style docstrings for classes and functions so Sphinx can parse them. New features should receive documentation in the closest matching docs/ location, with a new document added to docs/index.md when necessary. Bug fixes and CI-related changes do not require documentation updates. The skill is marked Apache-2.0 and is distributed in NVIDIA/skills, a catalog containing 324 separate skills.
It instructs an agent to inspect new or renamed Markdown files under docs/**/*.md, update docs/index.md, and place entries in the most appropriate section. It guides authors and reviewers toward Google-style docstrings for classes and functions, favoring docstrings over comments for externally used interfaces. For new features, it directs the agent to find the closest existing documentation or create a new document under docs/ and add it to docs/index.md.
- A NeMo-RL developer adds a Markdown document under docs/ and needs it indexed.
- A maintainer renames a documentation file and needs to keep docs/index.md aligned.
- A developer adds a class or function and needs a Sphinx-parseable Google-style docstring.
- A reviewer checks whether a NeMo-RL change follows the project's documentation and docstring conventions.
- A contributor ships a new feature and must choose the appropriate existing document or create a new one.
What are this skill's strengths and limitations?
- Covers three concrete areas: documentation indexing, feature documentation, and docstring format.
- Explains the relationship between Google-style docstrings and Sphinx parsing.
- Defines explicit exclusions that help limit inappropriate activation.
- Uses a plain SKILL.md format suitable for standard Agent Skills clients.
- Provides no scripts, automated validation commands, or test suite.
- Does not document the complete structure of docs/index.md or provide project-specific examples.
- The README documents installation for the broader NVIDIA/skills catalog, not this skill's local path or runtime details.
- It does not provide NeMo-RL training, debugging, or performance-tuning guidance.
How do you install this skill?
Install the named skill with the skills CLI command documented in the repository README:
npx skills add nvidia/skills --skill nemo-rl-docs --yes
The full NVIDIA skills catalog can also be installed with:
npx skills add nvidia/skills
The README does not specify the exact local installation directory for this skill.
How do you use this skill?
After installation, give the agent a NeMo-RL documentation task such as: “Update docs/index.md for the new NeMo-RL Markdown document and check that the affected classes and functions use Google-style docstrings.” Do not use this skill for bug fixes, test fixes, dependency bumps, refactoring, CI/CD changes, performance tuning, or tasks unrelated to writing or updating documentation.