About nemo-rl-docs
nemo-rl-docs is a repository skill for maintaining documentation conventions in a project. It covers the documentation index, Google-style docstrings, and when feature changes require documentation updates.
Key features
- 01Keep docs/index.md current
- 02Use Google-style docstrings
- 03Document new features in docs/
Use cases
- 01Adding or renaming Markdown documentation
- 02Writing public-facing class or function interfaces
- 03Updating docs when adding a feature
Install
Copy the command and run it in a terminal.
npx skills add https:/After installing, type/nemo-rl-docsin Claude Code to confirm it loaded.
Bundled files
References and scripts installed along with SKILL.md.
BENCHMARK.mdskill-card.mdskill.oms.sigevals/evals.jsonDetails
From the project READMEDocumentation 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.