nemo-rl-docs

Официальный skill NVIDIA описывает узкий workflow для документации NeMo-RL. Его назначение — добавлять и обновлять Markdown-документы, поддерживать индекс docs/index.md и оформлять docstrings в Google style, чтобы их можно было разбирать Sphinx. Это не общий skill для сопровождения репозитория: исходник прямо исключает bug fixes, test fixes, обновление зависимостей, рефакторинг, performance tuning и CI/CD. Если задача не связана с документацией или docstring, этот маршрут применять не следует. При добавлении нового Markdown-файла под docs/**/*.md сначала определяется наиболее подходящий раздел документации. После этого ссылка на новый файл должна появиться в docs/index.md. То же правило действует при переименовании существующего Markdown-документа: индекс нужно обновить так, чтобы путь и раздел оставались актуальными. Важен не только сам файл, но и навигация по документации: незарегистрированный документ может существовать в репозитории, но не будет отражён в предусмотренном индексом содержании. Skill не предлагает автоматически размещать страницу в произвольной категории и не утверждает, что любой новый текст относится к одному и тому же разделу. Для публичных интерфейсов, которыми могут пользоваться за пределами одного файла, источник рекомендует Google-style docstrings вместо обычных комментариев. Комментарии оставляются для локальной логики внутри функции или метода. Следовательно, при документировании класса или функции нужно выбрать соответствующий docstring, написать его в формате Google style и учитывать, что Sphinx должен суметь разобрать этот формат. Это правило не требует превращать каждую строку реализации в комментарий и не отменяет необходимость посмотреть на существующий стиль конкретного модуля. При создании новой feature документация должна быть добавлена или обновлена в docs/ в наиболее близком по смыслу месте. Если подходящего документа нет, workflow допускает создание нового. После этого docs/index.md также должен ссылаться на результат. Карточка полезна для ревью и небольших изменений: она удерживает связь между новым материалом, индексом и docstring-форматом. Она не определяет содержание самой feature, не генерирует API-контракт и не гарантирует полноту технического руководства без проверки реального кода NeMo-RL. Ограничения источника важны для безопасного применения. Исправление теста, production-кода, dependency bump или pipeline нельзя маскировать под documentation task только потому, что рядом есть Markdown. Не следует обновлять docs/index.md для несвязанного файла и не следует обещать Sphinx-совместимость без проверки фактического Google-style синтаксиса. Skill также не является руководством по запуску NeMo-RL, обучению моделей, настройке среды или релизу. Минимальный проверяемый результат — корректно изменённый документ или docstring, ссылка на него в индексе при необходимости и сохранение границы: кодовые, тестовые и CI/CD-изменения остаются отдельными задачами.