| name | nvidia-nemo-rl-docs |
| description | Documentation conventions for NeMo-RL. Covers docs/index.md updates and docstring format. |
| license | Apache-2.0 AND CC-BY-4.0 |
| metadata | {"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.","author":"NVIDIA"} |
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.
