nemo-rl-docs

What problem does it solve?

NeMo-RL projects often suffer from inconsistent documentation and missing guidance for docstrings and docs updates, leading to lower code quality and harder onboarding.

Core Features & Use Cases

• Documentation conventions: enforce Google-style docstrings and consistent docs/index.md updates across the codebase for NeMo-RL.
• Guided maintenance: provide clear procedures for adding/updating docs, docs pages, and docstrings within the NeMo-RL ecosystem.
• Use Case: when adding a new feature, follow the conventions to update docs/, add new markdown files, and ensure docs/index.md reflects the change.

Quick Start

Consult the Nemo-RL documentation conventions to apply consistent documentation practices when adding or updating documentation.