Loading skill
Install any skill in seconds. Free to start, no credit card required.
Get Started Free →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.
| Test case | Without → With | Effect | Δ tokens | Δ turns |
|---|---|---|---|---|
| case-09 | ✗→✓ | ▲ Improved | -57% | 0% |
| case-03 | ✗→✓ | ▲ Improved | -49% | 0% |
| case-04 | ✗→✓ | ▲ Improved | -52% | 0% |
| case-07 | ✗→✓ | ▲ Improved | -29% | 0% |
| case-13 | ✗→✓ | ▲ Improved | -63% | 0% |
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.
Other measured skills in the registry, with their headline benchmark lift.