维护这份手册
这页给内容维护者使用,不需要本地开发经验也能完成普通文字更新。
在 GitHub 修改文字
- 打开文档仓库。
- 进入
docs/,找到对应.md文件。 - 点击编辑,修改并预览。
- 提交到
main。 - 等待 GitHub Actions 构建完成。
添加页面
新增 Markdown 后,还要在 docs/.vitepress/config.mts 的侧栏中加入链接。页面标题使用清楚的任务名称,重要位置使用稳定英文锚点。
添加截图
截图放到 docs/public/images/。只保留完成操作所需区域,删除项目名、文件路径、邮箱、API Key、IP 和未授权工程数据。
发布前检查
bash
npm run test:links
npm run docs:build
npm run test:e2e构建失败时,GitHub Pages 保留上一次成功版本。修复错误后重新提交即可。