Skip to main content
知识中心

Repo Wiki

为代码仓库生成项目知识,并供 Qoder CN 在任务中使用。

Repo Wiki 可以把代码仓库整理为结构化项目知识。需要了解架构、追踪实现、评估改动影响或帮助新成员熟悉代码库时,可以先生成 Repo Wiki。

找到代码仓库

  1. 在左侧栏选择知识中心
  2. 打开 Repo Wiki 页签。
  3. 搜索目标代码仓库,并通过生成状态查看全部已生成未生成项目。
  4. 根据需要切换网格视图列表视图;选择刷新可重新获取状态。

生成 Repo Wiki

  1. 打开标记为未生成的代码仓库,或选择前往生成
  2. 语言中选择 English简体中文
  3. 检查生成选项:
    • 自动更新:代码变化后自动增量更新 Wiki。
    • 自动导出:生成后自动导出 Markdown。
    • 引用:允许 Agent 在任务中自动使用生成的知识作为上下文。
  4. 选择生成 Repo Wiki
生成会基于当前选择的代码库执行。开始前,请确认仓库中包含希望 Wiki 解释的分支、代码和项目文档。

在任务中使用

在同一工作区打开任务,并明确要理解的问题或准备进行的改动。例如,可以让 Qoder CN 说明模块调用路径、定位实现与调用方、总结改动影响,或查找项目约定。 Repo Wiki 用于提供项目上下文,实际运行行为仍可能与文档不同。重要结论应结合当前代码、配置、测试和运行输出确认。

保持内容有效

  • 及时维护源代码和仓库内的项目文档。
  • 在工作区索引中排除构建产物、依赖、缓存和无关路径。
  • 仓库发生重要变化后,检查 Repo Wiki 状态并更新生成的知识。
  • 生成后提出一个有代表性的架构或实现问题,确认所需上下文可以被正确使用。
不要把凭证、个人信息或受限数据写入代码仓库文档。