Documentation conventions for NeMo-RL. Covers docs/index.md updates and docstring format. Do NOT use for: bug fixes, test fixes, dependency bumps, refactoring, CI/CD changes, performance tuning, or any task that does not involve writing or updating documentation.
Use the nemo-rl-docs skill to review the new Markdown page I identify in this NeMo-RL workspace. Check whether docs/index.md lists it in the most appropriate section and recommend any documentation changes needed to describe its feature. Report a short list of suggested edits without changing files.
Required inputs
A NeMo-RL workspace containing docs/index.md.
The path to one new Markdown document under docs/ and a brief description of the feature it documents.
Previously published starter task based on a pinned source version; check the source and required inputs before running. Task evidence ↗
SKILL.md
name: nemo-rl-docslicense: Apache-2.0description: "Documentation conventions for NeMo-RL. Covers docs/index.md updates and docstring format. Do NOT use for: bug fixes, test fixes, dependency bumps, refactoring, CI/CD changes, performance tuning, or any task that does not involve writing or updating documentation."when_to_use: Adding or updating documentation; adding a new markdown file; reviewing docstrings; 'docs/index.md', 'docstring format', 'Sphinx', 'where do I add docs', during code review.
Documentation Conventions
Keep docs/index.md Up to Date
When a new markdown doc is added under docs/**/*.md or a markdown file is renamed, ensure that @docs/index.md is updated and the document appears in the most appropriate section.
Docstring Format
Use Google style docstrings for classes and functions. These are parseable by Sphinx.
For interfaces that may be used outside a file, prefer docstrings over comments. Comments should be reserved for code within a function or interfaces local to a file.
Document New Features
When a new feature is added, update or create documentation in the docs/ directory that most closely matches the feature. Look at existing docs to find the best fit — if none exists, create a new doc and add it to @docs/index.md.
Documentation changes are not required for bug fixes or CI-related changes.