Menu
Documentation conventions for NeMo-RL. Covers docs/index.md updates and docstring format.
| name | docs |
| description | Documentation conventions for NeMo-RL. Covers docs/index.md updates and docstring format. |
| 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. |
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.
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.
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.
Build and dependency management for NeMo-RL. Covers Docker image building and running, uv usage, venv setup, and adding dependencies.
CI/CD reference for NeMo-RL. Covers GitHub Actions pipeline structure, CI triggering via /ok to test, and CI failure investigation.
Configuration conventions for NeMo-RL. YAML is the single source of truth for defaults. Covers TypedDict usage, exemplar YAML updates, and forbidden default patterns.
Contribution conventions for NeMo-RL. Covers PR title format, commit sign-off, and CI triggering.
NVIDIA copyright header requirements for NeMo-RL. Covers which files need headers and the exact header text.
Error handling guidelines for NeMo-RL. Covers exception specificity, minimal try bodies, and else blocks.
