Maison
nemo-rl-docs
NVIDIA/skills
Mettre à jour le fichier docs/index.md et rédiger des chaînes de documentation (docstrings) au format Google pour les modifications apportées à la documentation de NeMo-RL.
...Développer toutConventions de documentation
Maintenir le fichier docs/index.md à jour
Lorsqu'un nouveau document Markdown est ajouté dans le répertoire docs/**/*.md ou qu'un fichier Markdown est renommé, veillez à ce que le fichier @docs/index.md soit mis à jour et que le document apparaisse dans la section la plus appropriée.
Format des chaînes de documentation
Utilisez des chaînes de documentation au format Google pour les classes et les fonctions. Celles-ci sont analysables par Sphinx.
Pour les interfaces susceptibles d’être utilisées en dehors d’un fichier, privilégiez les chaînes de documentation plutôt que les commentaires. Les commentaires doivent être réservés au code situé à l’intérieur d’une fonction ou aux interfaces locales à un fichier.
Documentation des nouvelles fonctionnalités
Lorsqu’une nouvelle fonctionnalité est ajoutée, mettez à jour ou créez la documentation dans le répertoire docs/ qui correspond le mieux à cette fonctionnalité. Consultez la documentation existante pour trouver celle qui convient le mieux — si aucune n’existe, créez un nouveau document et ajoutez-le à @docs/index.md.
Les modifications de la documentation ne sont pas obligatoires pour les corrections de bogues ou les modifications liées à l'intégration continue (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.
Tous les fichiers
5 fichiersInstaller nemo-rl-docs
Téléchargez et décompressez les fichiers de compétences dans votre répertoire .claude/skills/.
Télécharger le ZIPClonez le dépôt et copiez les fichiers de compétence dans votre projet.
git clone https://github.com/NVIDIA/skills/tree/main/skills/nemo-rl-docs # Copy SKILL.md to your .claude/skills/ directory
Copier
