Hogar
nemo-rl-docs
NVIDIA/skills
Actualiza el archivo docs/index.md y escribe cadenas de documentación al estilo de Google para los cambios en la documentación de NeMo-RL.
...Expandir todoConvenciones de documentación
Mantén actualizado el archivo docs/index.md
Cuando se añada un nuevo documento Markdown en la ruta «docs/**/*.md» o se cambie el nombre de un archivo Markdown, asegúrate de que se actualice @docs/index.md y de que el documento aparezca en la sección más adecuada.
Formato de las cadenas de documentación
Utiliza cadenas de documentación al estilo de Google para clases y funciones. Sphinx puede analizarlas.
Para las interfaces que puedan utilizarse fuera de un archivo, es preferible utilizar cadenas de documentación en lugar de comentarios. Los comentarios deben reservarse para el código dentro de una función o para interfaces locales de un archivo.
Documentar nuevas funcionalidades
Cuando se añada una nueva característica, actualice o cree la documentación en el directorio `docs/` que mejor se ajuste a dicha característica. Consulte la documentación existente para encontrar la que mejor se adapte; si no existe ninguna, cree un nuevo documento y añádalo a `@docs/index.md`.
No es necesario realizar cambios en la documentación para la corrección de errores ni para los cambios relacionados con la integración continua (CI).
---
name: nemo-rl-docs
description: Update docs/index.md and write Google-style docstrings for NeMo-RL documentation changes.
license: Apache-2.0
---
# 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](https://google.github.io/styleguide/pyguide.html) 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.
Todos los archivos
5 archivosInstalar nemo-rl-docs
Descarga y descomprime los archivos de habilidades en tu directorio .claude/skills/.
Descargar ZIPClona el repositorio y copia los archivos de la habilidad a tu proyecto.
git clone https://github.com/NVIDIA/skills/tree/main/skills/nemo-rl-docs # Copy SKILL.md to your .claude/skills/ directory
Copiar
