Nemo Rl Docs — Agent Skill by NVIDIA

From the author

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.

— the description by NVIDIA

AutoGineer summary

Written by AutoGineer from the skill’s own files, not by the author

This skill provides the established guidelines for maintaining documentation within the NeMo-RL project. It outlines the requirements for updating the central index file when new documentation is added and specifies the use of Google-style docstrings to ensure compatibility with Sphinx documentation generation.

What it does

Defines the structure for updating the project index file.
Mandates Google-style docstrings for classes and functions.
Provides guidance on where to place new documentation files.
Distinguishes between appropriate use of docstrings versus internal code comments.

When to use it

When adding or updating project documentation.
When creating new markdown files within the documentation directory.
When reviewing or writing docstrings for public interfaces.
When determining the correct location for new feature documentation.

Advantages

Ensures consistent documentation structure across the project.
Facilitates automated documentation generation via Sphinx.
Improves readability and maintainability of public-facing code interfaces.

Usage examples

“How should I format my function docstrings?”: The agent will advise using Google-style docstrings to ensure they are correctly parsed by Sphinx.
“Where do I register a new documentation file?”: The agent will instruct you to update the docs/index.md file and place the new file in the appropriate section.

Install

Download the skill as a ZIP:
https://mp-staging.autogineer.com/agent-skills/nvidia/nemo-rl-docs/download

Unzip it into the cross-client skills folder of your project:

mkdir -p .agents/skills && unzip nemo-rl-docs.zip -d .agents/skills

Documentation by NVIDIA

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 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.

Files

ATTRIBUTION.mdAdded by AutoGineer823 B
BENCHMARK.md4.1 KiB
LICENSELicence file added by AutoGineer11.2 KiB
SKILL.md1.4 KiB
evals/evals.json2.4 KiB
skill-card.md3.6 KiB
skill.oms.sig4.5 KiB

Requirements and compatibility

Works with: Claude Code, Claude apps, OpenAI Codex, GitHub Copilot, Cursor, Gemini CLI, Kiro, OpenCode, Goose, Amp, Roo Code, JetBrains Junie, Factory Droid, Devin (ex-Windsurf), Mistral Vibe, OpenHands, Letta

“Works with” means the tool reads the open Agent Skills format; a skill written for one tool may use features others lack.

Security

What our scanner noticed· Medium risk

Large base64-encoded blobs

A static scan is not a guarantee. Skills are third-party content: review a skill before you let an agent use it.

Doc Coauthoring
AnthropicOfficial
Guide users through a structured workflow for co-authoring documentation. Use when user wants to write documentation, proposals, technical specs, decision docs, or similar structured content. This workflow helps users efficiently transfer context, refine content through iteration, and verify the doc works for readers. Trigger when user mentions writing docs, creating proposals, drafting specs, or similar documentation tasks.
Documents and contentClaude CodeClaude appsOpenAI Codex+14 more
Link-onlyGitHub stars of the source repository188.6k
Markdown Mermaid Writing
K-Dense· Community
Generates scientific Markdown documentation and Mermaid structural diagrams for workflows, schemas, and relationships.
Documents and contentClaude CodeClaude appsOpenAI Codex+14 more
Apache-2.0Low riskGitHub stars of the source repository56.4k
JSON Canvas
Steph Ango (Obsidian)· Community
Create and edit JSON Canvas files for visual organization and mapping.
Documents and contentClaude CodeClaude appsOpenAI Codex+14 more
MITGitHub stars of the source repository51k
Obsidian Markdown
Steph Ango (Obsidian)· Community
Generate and format Obsidian-specific Markdown syntax for notes, links, and embeds.
Documents and contentClaude CodeClaude appsOpenAI Codex+14 more
MITGitHub stars of the source repository51k
Faq
AnthropicOfficial
Generate a team-specific FAQ document to address recurring questions about AI tool usage and project conventions.
Documents and contentClaude CodeClaude appsOpenAI Codex+14 more
Apache-2.0GitHub stars of the source repository46.3k
Hads
Seth Hobson· Community
A standardized Markdown format for technical documentation optimized for both human readability and AI model consumption.
Documents and contentClaude CodeClaude appsOpenAI Codex+14 more
MITGitHub stars of the source repository42.3k