SuperAPI AI 工具集

contribute-docs

编程与开发

查看项目

更新于 10-16 02:34

技能介绍

用途:在编写或编辑 NeMo Relay 的文档或示例时使用,尤其当改动涉及仓库特定的 MDX 格式、公共 API、集成说明或发布历史约定时。

主要能力与规则:优先使用已记录的公共 API,而非内部捷径;保持包名、仓库引用和构建命令为最新;记录贡献流程时,要求外部贡献 PR 前先有 issue,并说明 NVIDIA 贡献者可使用 GitHub 或 Linear issue;当示例或阅读路径变化时更新入口文档;发布流程与发布说明指导应放在 RELEASING.md 等维护者文档中,而非用户文档页或 CHANGELOG.md;文档和示例中稳定用户包装器保留在 scripts/ 根目录,仅在记录内部维护工作时指向命名空间辅助路径;若存在详细动态插件指南,Rust 原生插件示例、Python worker 插件示例和 grpc-v1 协议细节应分页;动态插件清单必须排除 0.8 之前的 Relay 版本,推荐 compat.relay = ">=0.8.0,<1.0";MDX 文件顶部注释须用 JSX 注释分隔符 {/* 和 */},不要用 HTML 注释;图片、图表、表格等视觉内容需在代表性页面宽度下清晰可读且完整可访问。

检查清单:入口点变化时更新 README.md 或 docs/index.yml;更新相关入门或参考文档;示例命令与当前包名和路径一致;示例或绑定指导变化时更新相关包或 crate 的 README.md;动态插件入口页链接到原生、worker、Rust 示例、Python 示例和协议页;新生成 MDX 文件使用 {/* ... */} 作为顶部 SPDX 注释;视觉内容在桌面和窄页面宽度下保持清晰可访问;发布策略文档仍指向 GitHub Releases 作为唯一发布历史来源;文档站点变化时运行 just docs,./scripts/build-docs.sh html 仍为兼容包装器。

参考:CONTRIBUTING.md、RELEASING.md、docs/contribute/testing-and-docs.mdx。

限制:资料未提供该技能的具体安装方式、收费信息或平台支持细节。