nemo-rl-docs
Compare original and translation side by side
🇺🇸
Original
English🇨🇳
Translation
ChineseDocumentation Conventions
文档规范
Keep docs/index.md Up to Date
保持 docs/index.md 内容更新
When a new markdown doc is added under or a markdown file is renamed, ensure that @docs/index.md is updated and the document appears in the most appropriate section.
docs/**/*.md当在 下添加新的Markdown文档或重命名Markdown文件时，请确保更新 @docs/index.md，并将文档放置在最合适的章节中。
docs/**/*.mdDocstring 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.
为类和函数使用Google风格的文档字符串，这类文档字符串可被Sphinx解析。
对于可能在文件外部使用的接口，优先使用文档字符串而非注释。注释应仅用于函数内部代码或文件本地的接口。
Document New Features
为新功能编写文档
When a new feature is added, update or create documentation in the 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.
docs/Documentation changes are not required for bug fixes or CI-related changes.
当添加新功能时，请在目录中更新或创建与该功能最匹配的文档。参考现有文档找到最合适的位置——如果没有合适的位置，请创建新文档并将其添加到@docs/index.md中。
docs/bug修复或CI相关变更无需修改文档。