关于 docs-platform-rollout
docs-platform-rollout 是一项用于搭建项目文档并通过 Docusaurus 和 Vercel 发布的自包含技能,涵盖文档结构、站点配置与本地构建验证。
主要功能
- 01搭建含治理元数据的 docs 结构
- 02在 website/ 设置 Docusaurus 站点
- 03配置 Vercel 部署
- 04添加文档相关根目录 npm 脚本
- 05验证本地站点构建
适用场景
- 01为新项目建立文档
- 02规范现有 docs/ 目录
- 03通过 Vercel 发布根目录文档
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ dhananjaypawar26/ docs-platform-rollout --skill docs-platform-rollout安装后在 Claude Code 中输入/docs-platform-rollout确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
README.mdreferences/docs-docusaurus-vercel.SKILL.mdproject-docs-bootstrap.SKILL.mdskills-usage-and-vercel-deployment.md详细介绍
文档平台上线
当用户希望一次性完成文档设置时,使用此技能。
范围
此技能是独立的,并在 references/ 中附带所需的实现细节。
内置参考资料:
references/project-docs-bootstrap.SKILL.mdreferences/docs-docusaurus-vercel.SKILL.mdreferences/skills-usage-and-vercel-deployment.md
如何加载参考资料
进行更改前,按以下顺序阅读参考资料:
references/project-docs-bootstrap.SKILL.mdreferences/docs-docusaurus-vercel.SKILL.md- 仅在需要部署或复用指导时阅读
references/skills-usage-and-vercel-deployment.md
工作流顺序
- 使用
references/project-docs-bootstrap.SKILL.md创建或规范化docs/结构和基线内容。 - 使用
references/docs-docusaurus-vercel.SKILL.md通过 Docusaurus 发布文档并配置 Vercel 部署。 - 验证本地文档构建,并列出部署步骤。
需确认的输入
- 项目/仓库名称
- 分支策略(自动部署或手动提升至生产环境)
- 所需文档路由(
/docs或/) - Vercel 根目录策略(仓库根目录或
website)
必需的输出
- 具备治理元数据、可用于生产环境的
docs/结构。 - 使用根目录文档的
website/Docusaurus 站点。 - 与根目录策略一致的
vercel.json。 - 根目录中的 npm 脚本,用于文档开发、构建和服务。
- 本地文档构建的验证结果。
验收标准
- 文档结构存在且内部一致。
npm --prefix website run build成功。- 侧边栏显示所有已配置的版块。
- Vercel 部署配置明确且可复现。
- 此技能可单独复制到其他仓库的
.agents/skills/docs-platform-rollout/下,并继续使用。
故障处理
- 如果文档构建失败,在完成前修复 MDX/侧边栏/路由问题。
- 如果 Vercel 设置失败,提供准确的备用模式(
Mode A或Mode B)以及分支/部署说明。
评论
支持 Markdown