skills.rest
yo-steven
yo-stevenCOMMUNITY
Explore all skills by this author →
GitHub

docs

Update docs index entries and standardize Google-style docstrings for NeMo-RL.

Updated May 23, 2026
Search Tags:#code review#documentation#technical writing#docstrings#sphinx#docs index
One-click install
npx skills add https://github.com/yo-steven/skills-exploration-20260522 --skill docs-yo-steven
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: docs
Source: https://github.com/yo-steven/skills-exploration-20260522/tree/main/skills/NeMo-RL/docs
Command: npx skills add https://github.com/yo-steven/skills-exploration-20260522 --skill docs-yo-steven

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps teams keep NeMo-RL documentation consistent and discoverable, reducing reviewer time and preventing broken or missing doc links after new files or docstrings are added.

Core Features & Use Cases

  • Keep docs/index.md synchronized: Ensure new docs/**/*.md files (or renamed docs) are added to docs/index.md in the right section.
  • Standardize docstrings for Sphinx: Use Google-style docstrings for classes and functions so Sphinx can parse them reliably.
  • Choose the right documentation location: Document new features in the docs/ area that best matches the change, creating a new doc and updating the index when needed.

Quick Start

Add or update your NeMo-RL documentation in docs/, then make sure the relevant docs/index.md entry is updated and your docstrings follow Google style.

Frequently Asked Questions about docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I keep documentation synchronized when adding new markdown files to a project?▼

To keep documentation synchronized, update the central docs index file whenever new markdown files are added or renamed, ensuring the entry is placed in the correct section for discoverability.

What is the correct docstring format for Sphinx parsing in Python projects?▼

Google style docstrings are the correct format for Sphinx parsing, allowing classes and functions to be documented reliably and consistently across the project.

How do I document new features during code review?▼

Document new features during code review by placing them in the matching docs directory, creating new markdown files, standardizing function docstrings, and updating the main documentation index.

Where should I place new technical documentation within a project structure?▼

New technical documentation should be placed in the specific docs directory that best matches the feature change, creating a new markdown file and updating the main index if necessary.

Why are my Sphinx API docs missing function descriptions after a build?▼

Sphinx API docs may miss function descriptions if docstrings do not follow Google style formatting, which is required for the parser to reliably extract and render class and function documentation.

Does this documentation standardization approach work for existing codebases?▼

Yes, this approach works for existing codebases by incrementally applying Google style docstrings to classes and functions and ensuring new markdown files are registered in the docs index.

Related Skills

Explore More Content & Communication Skills→
thenslsthensls

pydoc-pipeline

Generate Markdown API documentation from Python source code using AST parsing.

Official
Intermediate
wtthorntonwtthornton
4

documenter

Generate API documentation, READMEs, and docstrings in Markdown, reStructuredText, and HTML.

Community
Intermediate
gautam-achieveaigautam-achieveai
2

clean-builds

Automates code quality tools and package version validation in .NET projects.

Community
Advanced
JongsixJongsix

moai-docs-generation

Generate technical documentation from source code and API definitions.

Community
Advanced