项目的Code Wiki生成后,点击Code Wiki首页中的项目卡片,即可进入 Wiki 页面;你可以阅读Wiki文档,或者针对你感兴趣的问题来问答。
Code Wiki包含 AI Wiki、AI READEME 等类型文档。
# AI Wiki 文档
AI Wiki:为项目或模块生成的 多篇详细 文档,一般包含项目概述、系统架构、核心模块功能、核心流程等文档

# 使用方法
- 版本选择:在左上角可以选择项目或模块的、不同代码版本的Wiki文档
- 文档阅读:阅读区域包含左侧文档目录、中间文档内容、右侧文档内目录,你可以选择文档来阅读对应文档的内容
- 智能对话:在文档内容下方对话框,可以输入你感兴趣的问题,详见「智能对话」章节
# AI README 文档
AI README:为项目或模块生成的 单篇概述 文档,遵从规范的 README 结构,一般包含项目介绍、快速上手、常见问题、行为准则章节

# 使用方法
- 版本选择:在左上角可以选择项目或模块的、不同代码版本的Wiki文档
- 文档阅读:阅读区域包含文档内容、右侧文档内目录
- 合入仓库:点击“合入代码仓”按钮,可以创建 MR 将 AI README 合入仓库的分支
- 智能对话:在文档内容下方对话框,可以输入你感兴趣的问题,详见「智能对话」章节
# 智能对话
智能对话 提供了自然语言对话的方式,让你更灵活地获取你感兴趣的代码知识,不仅限于文档的内容,也可以问代码实现细节,比如系统架构、安全认证方式、函数的实现代码...
- 使用方式:自然语言对话
- 检索范围:实体代码&摘要 + Wiki 文档
- 辅助功能:历史对话、分享对话
# 使用方法
在 AI Wiki 、AI README 页面下方,输入你的提问后,会打开一个新会话页面,你可以查看AI回答内容和继续提问。

# 关联 Knot 知识库
如果你希望 智能对话 检索范围增加业务的 iwiki 等的知识库,以增强问答体验,可以通过「Knot知识库关联」来实现,关联方法:
- 入口:项目Wiki 页面右上方「更多设置」-「Knot知识库关联」
- 操作:点击添加按钮,下拉选择要关联的知识库名称,确认即可;如果下拉选项没有找到您想要关联的知识库,需在 知识库 添加 (处理成功后可使用)
# 查阅代码摘要
代码摘要与代码目录和代码实体一一对应,在工蜂网站的代码库页面上可以一边查看代码一边阅读摘要。 如果项目开通了CodeWiki,在版本库页面右侧点击“Code Wiki”按钮,展开代码摘要看板:
目录摘要:

实体摘要:

← 过滤源文件 定制 CodeWiki →