用途:在项目日常工作中创建和维护 Rspress v2 文档站点,强调以源码、测试、示例、包元数据和现有 README 为依据,而非泛泛而谈。
主要能力:为尚无文档站的项目新建 Rspress v2 站点;为用户可见功能、API、CLI 变更或 PR 更新已有 v2 文档;在文档工作前检测 Rspress v1 版本标记,并将迁移交给专门的 rspress-v2-upgrade 技能;把 Rspress 文档集成进 Rslib 包或工作区,同时保留仓库原有的包管理器与脚本。
使用方式:先检查项目,定位包文件、源码入口、示例、测试、变更日志和 README;查找 rspress.config.ts、.js、.mjs 或 .cjs 配置文件;检查依赖中的 Rspress 版本标记,如 @rspress/core 版本、旧版 rspress 包或 rspress/* 导入、@rspress/plugin-*;根据锁文件(pnpm-lock.yaml、yarn.lock、package-lock.json、bun.lock、bun.lockb)和 pnpm-workspace.yaml 判断包管理器与工作区。若存在配置,从其 root 选项解析文档根目录;无 root 时检查脚本、CI 命令中的 rspress dev site、rspress build site、rspress preview site 等位置参数,再回退到默认 docs/ 目录;无配置时检查 docs/、doc/、website/、site/ 等常见目录。随后按情况选择新建文档、版本守卫或为 PR 维护文档。
验证:在 Rspress 项目目录或通过仓库根脚本运行文档构建,构建通过是主要成功标准;完成前修复失效链接、缺失导航项、无效 frontmatter 和失败的 MDX 导入。示例命令:pnpm create rspress@latest、pnpm run build(按仓库包管理器替换为 npm、yarn 或 bun)。维护 PR 文档时先看变更源码,再更新对应文档页与导航,例如 src/formatBytes.ts 对应 website/docs/api/formatBytes.mdx 与 website/docs/api/_meta.json。
限制:资料未提供具体收费、平台支持范围或效果保证;实际可用性取决于项目环境与 Rspress 版本。