# Nemo Rl Docs

> Update docs/index.md and write Google-style docstrings for NeMo-RL documentation changes.

- Skill: `nvidia/nemo-rl-docs` (Agent Skill, multi-file: 5 files)
- Install (CLI): `npx skillmds@latest add nvidia/nemo-rl-docs`
- Raw SKILL.md: https://api.skillmd.com/api/skills/nvidia/nemo-rl-docs/raw
- Safety review: PASS (external: skill-scanner PASS, skillspector PASS)
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Docs & Writing, DevOps & Infra, Technical Writing
- Tags: Documentation Conventions, Google Style Docstrings, Markdown, Nemo Rl, Sphinx
- License: Apache-2.0
- Author: NVIDIA (https://skillmd.com/u/nvidia), verified publisher
- Updated: 2026-07-06
- Page: https://skillmd.com/skills/nvidia/nemo-rl-docs

---


# 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](https://google.github.io/styleguide/pyguide.html) 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.