forked from Gitlink/gitlink-cli
156 lines
4.8 KiB
Markdown
156 lines
4.8 KiB
Markdown
# Claude Code 验证记录 — gitlink-docs-assistant
|
||
|
||
**验证日期：** 2026-06-16
|
||
**验证平台：** Claude Code
|
||
**验证仓库：** ylly/gitlink-cli
|
||
**验证人：** ZxR
|
||
**gitlink-cli 版本：** 本地源码构建（go1.26.3, windows/amd64）
|
||
|
||
---
|
||
|
||
## 0. 环境确认
|
||
|
||
```bash
|
||
$ gitlink-cli auth status
|
||
✓ Logged in as ylly
|
||
|
||
$ gitlink-cli user +me
|
||
{ "ok": true, "data": { "login": "ylly", "user_id": 148899, "username": "ylly" } }
|
||
```
|
||
|
||
📷 环境截图见 `screenshots/00-环境确认.png`
|
||
|
||
---
|
||
|
||
## 1. 验证工作流 1：文档完整性体检（只读）
|
||
|
||
**喂入 Skill：** 在 Claude Code 中输入
|
||
> 请阅读 skills/gitlink-docs-assistant/SKILL.md，帮我检查 ylly/gitlink-cli 仓库的文档完整性。
|
||
|
||
**Agent 执行过程（真实命令输出）：**
|
||
|
||
| 步骤 | 命令 | 结果 |
|
||
|------|------|:----:|
|
||
| 获取仓库信息 | `gitlink-cli repo +info --owner ylly --repo gitlink-cli --format json` | ✅ 返回仓库元数据 |
|
||
| 读取 README | `gitlink-cli repo +readme --owner ylly --repo gitlink-cli` | ✅ 返回 README 全文 |
|
||
| 列出 Wiki 页面 | `gitlink-cli wiki +list --owner ylly --repo gitlink-cli --format json` | ✅ 返回 6 个页面 |
|
||
|
||
**Wiki 列表实际返回：**
|
||
```
|
||
"title": "新的测试wiki"
|
||
"title": "HOME"
|
||
"title": "_Sidebar"
|
||
"title": "demopage"
|
||
"title": "wiki"
|
||
"title": "wikkkkww"
|
||
```
|
||
|
||
**真实发现（验证过程中记录）：**
|
||
- `README` ✅ 存在、`LICENSE` ✅ 存在（MulanPSL-2.0）
|
||
- `CONTRIBUTING` / `CHANGELOG` / `API 文档` ❌ 全部缺失
|
||
- Wiki 中的页面均为测试遗留，无正式文档
|
||
- 注：`api GET /:owner/:repo/sub_entries` 端点在本环境返回 HTML 而非文件列表，故改用 `repo +readme` 作为更可靠的 README 检测方式（已在 SKILL.md 注意事项中记录）
|
||
|
||
**Agent 输出的体检报告：**
|
||
|
||
```markdown
|
||
📋 文档体检报告 — ylly/gitlink-cli
|
||
总体评级：🟡 待完善
|
||
|
||
| 检查项 | 状态 | 建议 |
|
||
|--------------|:----:|-------------------|
|
||
| README | ✅ | — |
|
||
| LICENSE | ✅ | MulanPSL-2.0 |
|
||
| CONTRIBUTING | ❌ | 建议创建 Wiki 页面 |
|
||
| CHANGELOG | ❌ | 建议创建 Wiki 页面 |
|
||
| API 文档 | ❌ | 建议创建 Wiki 页面 |
|
||
```
|
||
|
||
📷 体检报告截图见 `screenshots/01-体检报告.png`
|
||
|
||
---
|
||
|
||
## 2. 验证工作流 2：AI 自动补全文档（写入 Wiki）
|
||
|
||
**Agent 执行命令：**
|
||
|
||
```bash
|
||
$ gitlink-cli wiki +create --owner ylly --repo gitlink-cli \
|
||
--name "CONTRIBUTING" \
|
||
--content "# 贡献指南 (CONTRIBUTING) ..." \
|
||
--message "docs: AI 自动生成 CONTRIBUTING 文档"
|
||
```
|
||
|
||
**真实返回（关键字段）：**
|
||
|
||
```json
|
||
{
|
||
"ok": true,
|
||
"data": {
|
||
"code": 201,
|
||
"data": {
|
||
"title": "CONTRIBUTING",
|
||
"html_url": "https://gitlink.org.cn/ylly/gitlink-cli/wiki/CONTRIBUTING",
|
||
"last_commit": {
|
||
"sha": "0a5741cfbcac81fcb2ffa78299404a78cfe2a70e",
|
||
"date": "2026-06-16T00:15:53Z"
|
||
},
|
||
"commit_count": 1
|
||
}
|
||
}
|
||
}
|
||
```
|
||
|
||
**确认创建成功：** `wiki +list` 重新查询，CONTRIBUTING 已出现在列表中 ✅
|
||
|
||
📷 创建成功截图见 `screenshots/02-wiki创建成功.png`
|
||
（也可访问 https://gitlink.org.cn/ylly/gitlink-cli/wiki/CONTRIBUTING 查看真实页面）
|
||
|
||
---
|
||
|
||
## 3. 验证工作流 3：文档同步更新（更新 Wiki）
|
||
|
||
**Agent 执行命令（检测到内容可补充后提交更新）：**
|
||
|
||
```bash
|
||
$ gitlink-cli wiki +update --owner ylly --repo gitlink-cli \
|
||
--name "CONTRIBUTING" \
|
||
--content "# 贡献指南 ...（更新后含文档维护说明）" \
|
||
--message "docs: 同步更新 CONTRIBUTING（补充文档维护说明）"
|
||
```
|
||
|
||
**真实返回：**
|
||
|
||
```json
|
||
{ "ok": true, "data": { "code": 200, "data": { "title": "CONTRIBUTING", "commit_count": 2 } } }
|
||
```
|
||
|
||
**更新成功证据：** `commit_count` 由 `1` → `2`，证明更新已生效 ✅
|
||
|
||
📷 更新成功截图见 `screenshots/03-wiki更新成功.png`
|
||
|
||
---
|
||
|
||
## 验证结论
|
||
|
||
| 工作流 | 结果 |
|
||
|--------|:----:|
|
||
| 工作流 1：文档体检（只读） | ✅ 通过 |
|
||
| 工作流 2：AI 自动补全文档（写入） | ✅ 通过（code 201） |
|
||
| 工作流 3：文档同步更新（写入） | ✅ 通过（code 200，commit 1→2） |
|
||
|
||
- **Agent 平台：** Claude Code
|
||
- **真实仓库验证：** ylly/gitlink-cli（写入操作已生效，可在 GitLink 网页查看）
|
||
- **兼容性：** 标准 YAML frontmatter，兼容 Claude Code / Cursor / OpenClaw
|
||
|
||
---
|
||
|
||
## 截图清单
|
||
|
||
| 文件名 | 对应步骤 | 内容 |
|
||
|--------|---------|------|
|
||
| `screenshots/00-环境确认.png` | 第 0 步 | auth status + user +me 登录成功 |
|
||
| `screenshots/01-体检报告.png` | 工作流 1 | 体检报告输出 |
|
||
| `screenshots/02-wiki创建成功.png` | 工作流 2 | wiki +create 返回 code 201 + 列表确认 |
|
||
| `screenshots/03-wiki更新成功.png` | 工作流 3 | wiki +update 返回 commit_count 1→2 |
|