nemo-rl-docs

The nemo-rl-docs skill is a concise conventions guide for writing and updating documentation in the NeMo-RL project. It solves the common drift between code and docs by codifying a few clear rules that keep documentation discoverable and consistently formatted, and it deliberately scopes itself out of non-documentation tasks such as bug fixes, test fixes, dependency bumps, refactoring, CI/CD changes, and performance tuning.

The guidance is short and specific: when a new markdown doc is added under docs or a markdown file is renamed, docs/index.md must be updated so the document appears in the most appropriate section; classes and functions use Google-style docstrings that Sphinx can parse, with docstrings preferred over comments for interfaces used outside a file; and when a new feature is added, documentation in the docs directory should be updated or created to match it. It explicitly notes that documentation changes are not required for bug fixes or CI-related changes.

Target users are developers and engineers contributing to NeMo-RL who are adding or updating documentation, adding new markdown files, or reviewing docstrings during code review. This is a thin, guide-only convention reference rather than a tool that executes anything; it points to the Google Python Style Guide and NeMo-RL documentation as external references and carries no scripts or automation.