Rooftop

OpenWiki 实践

3分钟阅读

实践对象：之前为AI照片项目写的AI照片评测平台，内容主要是前端显示+后端的推理代码

1. 安装OpenWiki

用Node 22.22.3 运行OpenWiki 0.2.3

source /Users/user/.nvm/nvm.sh
 
nvm use 22.22.3
 
node --version
npm --version
npm install -g openwiki@0.2.3
 
npm list -g openwiki --depth=0
openwiki --help

2. 定义Wiki的生成范围

创建目录：

mkdir -p openwiki

创建 openwiki/INSTRUCTIONS.md

用来指导创建和维护仓库代码的Wiki，包括代码的覆盖范围和文档。

它告诉 OpenWiki：这次 Wiki 应该覆盖哪些目录、忽略哪些内容、用什么语言、哪些事实不能乱猜、哪些工作流要重点写。它直接影响 Wiki 生成质量。与LLM-Wiki中提到的AGETNS.md功能相似。

OpenWiki中的AGENTS.md起到一个路由的作用，告诉agent进入仓库后读取openwiki/quickstart的内容。

# AI Photo Evaluation Wiki Instructions

## 目标

为 AI Photo Evaluation 模型评估平台生成面向开发者和编码 Agent 的 Wiki。

Wiki 需要帮助读者理解：

- React 前端、Node.js 服务和 Python 推理服务如何协作；

- 二选一、排序评测、本地上传、五点调参和模型对比如何工作；

- API、SQLite 数据、图片和模型推理结果如何流转；

- 修改过滤规则、增加指标或接入新模型时需要修改哪些代码；

- 如何启动、部署和排查平台问题。

## 核心代码范围

重点分析：

- model-eval-server/

- tantan-moment-op-web/src/routes/ModelEval/

- tantan-moment-op-web/src/utils/routeConfig.js

- tantan-moment-op-web/src/router.js

- tantan-moment-op-web/src/utils/request.js

- tantan-moment-op-web/package.json

......

3. 获取API Key

OpenWiki是开源项目，所以生成Wiki的模型是可以自己设置的，我选择了DeepSeek。 先到DeepSeek开放平台创建API Key。

4. 配置OpenWiki

打开OpenWiki的本地配置：

mkdir -p ~/.openwiki
nano ~/.openwiki/.env

加入：

OPENWIKI_PROVIDER=openai-compatible
OPENAI_COMPATIBLE_API_KEY=你的_DeepSeek_API_Key
OPENAI_COMPATIBLE_BASE_URL=https://api.deepseek.com
OPENWIKI_MODEL_ID=deepseek-v4-flash

5. 启动OpenWiki

进入对应仓库

cd /Users/user/Desktop/code/tantan-cms

第一次执行：

openwiki code --init

如果此前已经初始化过，只想重新生成或更新：

openwiki code --update

看到如图页面，选择OpenAI-compatible，就是我们配置的DeepSeek。

然后就能看到生成的openwiki/相关内容。

6. gitlab配置.gitlab-ci.yml 文件

这个任务会：

  • 读取仓库源码
  • 调用DeepSeek
  • 更新CI临时工作区中的Wiki
  • 把结果作为Artifact提供下载
  • 不提交、不推送，也不创建MR

7. Run Pipeline

填入DeepSeek API

8. 生成当前代码库的Wiki

下载下来是跟在本地执行openwiki指令生成一样的内容