forked from Gitlink/gitlink-cli
86 lines
1.9 KiB
Markdown
86 lines
1.9 KiB
Markdown
# 每周刷新 FAQ 知识库示例
|
||
|
||
> 端到端演示：定期从 Issue 提取 Q&A，更新知识库 Wiki。
|
||
|
||
## 场景
|
||
|
||
gitlink-cli 项目维护者，本周关闭了 20 个 Issue，想更新 FAQ 知识库。
|
||
|
||
## 完整对话流程
|
||
|
||
### 触发
|
||
|
||
```
|
||
用户: 帮我整理这周关闭的 Issue，更新 FAQ
|
||
|
||
AI: 好的，先采集最近的 Issue。
|
||
```
|
||
|
||
### Step 1-2: 采集 + 筛选
|
||
|
||
```bash
|
||
gitlink-cli issue +list --state closed --limit 100 --format json
|
||
```
|
||
|
||
```
|
||
AI 采集到 20 个 Issue：
|
||
- 排除 3 个测试 Issue
|
||
- 剩余 17 个有效 Issue，读取详情并提取 Q&A 中...
|
||
```
|
||
|
||
### Step 3-4: 提取 Q&A + 合并同类问题
|
||
|
||
```
|
||
AI 展示分析结果：
|
||
|
||
📖 从 17 个 Issue 中提取了 12 条 FAQ（已合并 5 组同类问题）
|
||
|
||
## 安装配置
|
||
### Q1: 安装 gitlink-cli 后运行报 command not found 怎么办？
|
||
**A:** 将 ~/.local/bin 加入 PATH...
|
||
> 📎 来源: #16, #20
|
||
|
||
### Q2: 如何配置企业代理？
|
||
**A:** 设置 HTTP_PROXY 和 HTTPS_PROXY 环境变量...
|
||
> 📎 来源: #42
|
||
|
||
## CLI 命令
|
||
### Q3: issue +view 返回的 JSON 缺少部分字段？
|
||
**A:** 这是已知的 API 版本差异，部分字段需要特定 API 版本才返回...
|
||
> 📎 来源: #5, #7, #15
|
||
|
||
### Q4: pr +list 在 Windows 下输出乱码？
|
||
**A:** 设置终端编码为 UTF-8：chcp 65001...
|
||
> 📎 来源: #33
|
||
|
||
## API 与集成
|
||
### Q5: 能否支持在 CI 中使用 Token 认证？
|
||
**A:** 已支持。设置 GITLINK_TOKEN 环境变量即可...
|
||
> 📎 来源: #28
|
||
|
||
...
|
||
```
|
||
|
||
### Step 5: 生成并确认
|
||
|
||
```
|
||
AI 生成 FAQ Markdown，展示预览...
|
||
|
||
用户: 可以，发布到 Wiki
|
||
|
||
AI: 好的，更新 Wiki 页面...
|
||
```
|
||
|
||
### Step 6: 发布
|
||
|
||
```bash
|
||
gitlink-cli wiki +update --title "Issue-知识库" --file ./issue-faq.md
|
||
```
|
||
|
||
```
|
||
AI: ✅ FAQ 知识库已更新！
|
||
- Wiki 页面: Issue-知识库
|
||
- 本次新增: 17 条 Issue → 12 条 FAQ（合并 5 组同类问题）
|
||
- 下次建议: 2 周后刷新
|
||
```
|