用途:该技能适用于仅文档或示例密集型的改动,帮助贡献者让文档与示例继续与 NeMo Fabric 的公开行为保持一致。
主要能力与规则:优先使用已记录的公开 API,而非内部捷径;保持包名、仓库引用与构建命令为最新;当示例或阅读路径变化时更新入口文档;发布流程与发布历史政策保留在 RELEASING.md,不写入面向用户的文档,也不重复创建 CHANGELOG.md。写新文档时,只有需要另起段落或为代码块、章节标题添加空行时才加入 \n 换行符,不强制行宽,仅应用于新写文本或正在编辑的段落,不整篇重排。MDX 文件顶部注释必须使用 JSX 注释定界符 {/* 开始、*/} 结束,不要用 HTML 注释写 MDX SPDX 头。
检查清单:入口点变化时更新 README.md 或 docs/index.yml;更新相关入门或参考文档;示例命令仍匹配当前包名与路径;示例或适配器变化时更新相关适配器或示例 README.md;新增或重新生成的 MDX 文件使用 {/* ... */} 作为顶部 SPDX 注释;文档站点有改动时运行 just docs。
配套指引:实现或评审工作可配合 karpathy-guidelines 使用;保持改动范围收敛,暴露假设,编辑前定义聚焦的验证方式。
参考:README.md、RELEASING.md、docs/index.yml、review-doc-style。
限制:资料未提供安装命令、价格、平台支持范围及具体适用场景更多细节。