nemo-rl-docs 是维护 NeMo-RL 文档入口与说明格式的 Skill。它要求新增或改名的文档接回合适索引,也区分公共接口说明与函数内部注释。
文件写好了但索引没链接,读者和构建系统可能仍找不到。新功能先看已有文档位置,相关说明放在读者会去的地方,而不是到处另建一个近似页面。
主文选用 Google 风格文档字符串,便于 Sphinx 处理,但解析成功不说明说明符合实际参数或返回值。重命名以后也要核旧链接和生成文档,不能只改文件路径。
适合这个项目的文档维护。本文未改项目文档或运行构建,外部风格完整说明未展开;原文不强制每次缺陷或 CI 修改都写文档,并不意味着用户可见行为说明过时也应保持原样。