docs: refactor documentation structure and add new content#1
docs: refactor documentation structure and add new content#1weijinglin wants to merge 18 commits intomasterfrom
Conversation
Walkthrough本次更新主要新增和完善了 HugeGraph 及其相关组件（如 HugeGraph-AI、HugeGraph-PD、HugeGraph-Store、ToolChain 等）的中英文快速入门文档。内容涵盖分布式存储引擎的配置与部署、AI 模块的核心逻辑与操作流程、各组件的部署方法、配置参数、启动与验证步骤，以及界面操作说明。部分文档对原有内容进行了结构优化和细节补充。 Changes
Sequence Diagram(s)sequenceDiagram
participant 用户
participant HugeGraph-AI
participant 向量数据库
participant HugeGraph-Server
participant LLM
用户->>HugeGraph-AI: 上传文档/Schema/Prompt
HugeGraph-AI->>LLM: 文本分割与向量化
HugeGraph-AI->>向量数据库: 写入文本块向量
HugeGraph-AI->>LLM: 图谱抽取
HugeGraph-AI->>HugeGraph-Server: 写入图结构
HugeGraph-AI->>LLM: 节点向量化
HugeGraph-AI->>向量数据库: 写入节点向量
用户->>HugeGraph-AI: 发起自然语言查询
HugeGraph-AI->>LLM: 向量化问题
HugeGraph-AI->>向量数据库: 检索相关文本/节点
HugeGraph-AI->>HugeGraph-Server: 关键词/Gremlin 查询
HugeGraph-AI->>LLM: 综合生成答案
HugeGraph-AI->>用户: 返回最终答案
Poem
✨ Finishing Touches🧪 Generate Unit Tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 8
🔭 Outside diff range comments (1)
content/en/docs/quickstart/hugegraph/hugegraph-server.md (1)
422-428:⚠️ Potential issue后台配置注释错误
ScyllaDB 部分块的注释仍写为# cassandra backend config，应修正为# scylladb backend config，避免误导。- # cassandra backend config + # scylladb backend config
🧹 Nitpick comments (21)
content/cn/docs/quickstart/hugegraph/hugegraph-pd.md (2)
1-5: 文档标题本地化建议
title 字段仍为英文，与其余中文页面不一致。建议将title: "HugeGraph-PD Quick Start"修改为
title: "HugeGraph-PD 快速开始"以保持中文文档风格统一。
118-120: 补充代码块语言标记
日志示例的 fenced code block 缺少语言声明，建议改为：- ``` + ```text 2024-xx-xx xx:xx:xx [main] [INFO] o.a.h.p.b.HugePDServer - Started HugePDServer in x.xxx seconds (JVM running for x.xxx)<details> <summary>🧰 Tools</summary> <details> <summary>🪛 markdownlint-cli2 (0.17.2)</summary> 118-118: Fenced code blocks should have a language specified null (MD040, fenced-code-language) </details> </details> </blockquote></details> <details> <summary>content/cn/docs/quickstart/hugegraph/hugegraph-hstore.md (2)</summary><blockquote> `1-5`: **文档标题本地化建议** title 字段仍为英文，建议将 ```yaml title: "HugeGraph-Store Quick Start"修改为
title: "HugeGraph-Store 快速开始"或
title: "HugeGraph-Store 快速入门"以保持中文页面的一致性。
118-120: 补充日志代码块语言标记
日志示例代码块缺少语言声明，建议使用text或console：- ``` + ```text 2024-xx-xx xx:xx:xx [main] [INFO] o.a.h.s.n.StoreNodeApplication - Started StoreNodeApplication in x.xxx seconds (JVM running for x.xxx)<details> <summary>🧰 Tools</summary> <details> <summary>🪛 markdownlint-cli2 (0.17.2)</summary> 118-118: Fenced code blocks should have a language specified null (MD040, fenced-code-language) </details> </details> </blockquote></details> <details> <summary>content/cn/docs/quickstart/computing/_index.md (1)</summary><blockquote> `1-5`: **中文文档导航项未本地化** 当前 `content/cn` 下的 front matter `title` 和 `linkTitle` 均为英文，建议将其翻译为中文，以匹配页面语言环境。 </blockquote></details> <details> <summary>content/cn/docs/quickstart/hugegraph/_index.md (1)</summary><blockquote> `1-5`: **中文文档导航项未本地化** 当前 `content/cn` 下的 front matter `title` 和 `linkTitle` 仍为英文，建议翻译为中文，提升文档一致性。 </blockquote></details> <details> <summary>content/en/docs/quickstart/hugegraph/hugegraph-pd.md (1)</summary><blockquote> `15-15`: **术语大小写** “MacOS” 建议改为 Apple 官方标准写法 “macOS”。 ```diff - Operating System: Linux or MacOS (Windows has not been fully tested) + Operating System: Linux or macOS (Windows has not been fully tested)🧰 Tools
🪛 LanguageTool
[grammar] ~15-~15: The operating system from Apple is written “macOS”.
Context: ...uirements - Operating System: Linux or MacOS (Windows has not been fully tested) - J...(MAC_OS)
content/en/docs/quickstart/hugegraph/hugegraph-server.md (1)
243-243: 用词重复
此处 “Also, you need to modify...” 与前文多次表述相似，建议改为 “此外，请修改...” 以提升可读性。content/en/docs/quickstart/hugegraph/hugegraph-hstore.md (4)
7-10: 建议简化措辞
“works in conjunction with” 可替换为更简洁的 “works with” 以提升可读性。🧰 Tools
🪛 LanguageTool
[style] ~9-~9: ‘in conjunction with’ might be wordy. Consider a shorter alternative.
Context: ...oring and managing graph data. It works in conjunction with HugeGraph-PD to form HugeGraph's distri...(EN_WORDINESS_PREMIUM_IN_CONJUNCTION_WITH)
15-17: 操作系统名称格式
“MacOS” 建议统一写为 “macOS”，与官方命名保持一致。🧰 Tools
🪛 LanguageTool
[grammar] ~15-~15: The operating system from Apple is written “macOS”.
Context: ...uirements - Operating System: Linux or MacOS (Windows has not been fully tested) - J...(MAC_OS)
117-121: 指定日志示例代码块语言
当前日志示例使用无语言标记的，建议改为text 或 ```console，以便渲染和高亮。🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
118-118: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
149-189: 多节点示例代码块缺少语言标记
以下 YAML 配置示例块均使用无语言标记的，建议改为yaml 以增强可读性。content/cn/docs/quickstart/hugegraph-ai/quick_start.md (2)
7-8: 区块引用格式
在单行>引用后出现空行，建议移除空行或在下一行也加上>，以符合 Markdown 风格指南。
24-25: 图片替换为描述性 Alt 文本
当前所有![image]建议替换为更具语义的描述，如![RAG 构建流程示意图]，提高可访问性。content/cn/docs/quickstart/hugegraph-ai/_index.md (3)
7-10: 引用链接清晰度
第一段中提示用户参考 README，可考虑将“请参考 AI 仓库的 README”改为“请参考 HugeGraph-AI 项目仓库的 README”，以免歧义。🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
8-8: Blank line inside blockquote
null(MD028, no-blanks-blockquote)
69-72: 指定代码块语言
bash之后的示例在少数场景中使用无语言标记的，建议统一标注为bash。
115-119: 指定 Shell 代码块语言
python -m hugegraph_llm.config.generate --update代码块前使用无语言标记的，建议改为bash 增强渲染。content/en/docs/quickstart/hugegraph-ai/_index.md (2)
7-7: 移除尾部多余波浪号
Blockquote 末尾的 “~” 似为编辑遗留，应删除以保持专业和一致。
13-15: 删除多余定冠词
将 “Thehugegraph-llmis a tool” 改为 “hugegraph-llm是一个工具”，去掉英文中的多余 “The”。content/en/docs/quickstart/hugegraph-ai/quick_start.md (2)
7-8: 区块引用格式
同样在这份文档中，单行>后出现空行，建议移除以统一样式。
24-25: 补充图片 Alt 文本
建议为所有![image]添加更具语义的 Alt 文本，如![构建流程示意]，提升可访问性。
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (18)
content/cn/docs/quickstart/client/_index.md(1 hunks)content/cn/docs/quickstart/computing/_index.md(1 hunks)content/cn/docs/quickstart/hugegraph-ai/_index.md(4 hunks)content/cn/docs/quickstart/hugegraph-ai/quick_start.md(1 hunks)content/cn/docs/quickstart/hugegraph/_index.md(1 hunks)content/cn/docs/quickstart/hugegraph/hugegraph-hstore.md(1 hunks)content/cn/docs/quickstart/hugegraph/hugegraph-pd.md(1 hunks)content/cn/docs/quickstart/hugegraph/hugegraph-server.md(7 hunks)content/cn/docs/quickstart/toolchain/_index.md(1 hunks)content/en/docs/quickstart/client/_index.md(1 hunks)content/en/docs/quickstart/computing/_index.md(1 hunks)content/en/docs/quickstart/hugegraph-ai/_index.md(5 hunks)content/en/docs/quickstart/hugegraph-ai/quick_start.md(1 hunks)content/en/docs/quickstart/hugegraph/_index.md(1 hunks)content/en/docs/quickstart/hugegraph/hugegraph-hstore.md(1 hunks)content/en/docs/quickstart/hugegraph/hugegraph-pd.md(1 hunks)content/en/docs/quickstart/hugegraph/hugegraph-server.md(5 hunks)content/en/docs/quickstart/toolchain/_index.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
content/cn/docs/quickstart/hugegraph/hugegraph-pd.md
118-118: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
content/en/docs/quickstart/hugegraph/hugegraph-pd.md
118-118: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
content/cn/docs/quickstart/hugegraph/hugegraph-hstore.md
118-118: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
content/en/docs/quickstart/hugegraph/hugegraph-hstore.md
118-118: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
content/cn/docs/quickstart/hugegraph-ai/_index.md
8-8: Blank line inside blockquote
null
(MD028, no-blanks-blockquote)
57-57: Bare URL used
null
(MD034, no-bare-urls)
99-99: Bare URL used
null
(MD034, no-bare-urls)
108-108: Bare URL used
null
(MD034, no-bare-urls)
123-123: Strong style
Expected: asterisk; Actual: underscore
(MD050, strong-style)
123-123: Strong style
Expected: asterisk; Actual: underscore
(MD050, strong-style)
🪛 LanguageTool
content/en/docs/quickstart/hugegraph/hugegraph-pd.md
[grammar] ~15-~15: The operating system from Apple is written “macOS”.
Context: ...uirements - Operating System: Linux or MacOS (Windows has not been fully tested) - J...
(MAC_OS)
content/en/docs/quickstart/hugegraph/hugegraph-hstore.md
[style] ~9-~9: ‘in conjunction with’ might be wordy. Consider a shorter alternative.
Context: ...oring and managing graph data. It works in conjunction with HugeGraph-PD to form HugeGraph's distri...
(EN_WORDINESS_PREMIUM_IN_CONJUNCTION_WITH)
[grammar] ~15-~15: The operating system from Apple is written “macOS”.
Context: ...uirements - Operating System: Linux or MacOS (Windows has not been fully tested) - J...
(MAC_OS)
content/cn/docs/quickstart/hugegraph-ai/_index.md
[uncategorized] ~114-~114: 动词的修饰一般为‘形容词（副词）+地+动词’。您的意思是否是：最新"地"更改
Context: ...存到配置文件中。你也可以直接修改文件而无需重启应用程序；只需刷新页面即可加载最新的更改。 （可选）要重新生成配置文件，您可以将 `config.gener...
(wb4)
content/en/docs/quickstart/hugegraph/hugegraph-server.md
[style] ~244-~244: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...ver-2 server.role=worker ``` Also, you need to modify the port configuration in `greml...
(REP_NEED_TO_VB)
content/en/docs/quickstart/hugegraph-ai/quick_start.md
[style] ~22-~22: ‘vid’ is informal. Consider replacing it.
Context: ...nowledge graph, chunk vector, and graph vid vector from the text. 
[style] ~61-~61: ‘Vid’ is informal. Consider replacing it.
Context: ...** Clear chunk vector - Clear Graph Vid Vector Index: Clear graph vid vector ...
(VID)
[style] ~61-~61: ‘vid’ is informal. Consider replacing it.
Context: ...r Graph Vid Vector Index**: Clear graph vid vector - Clear Graph Data: Clear ...
(VID)
[style] ~65-~65: ‘Vid’ is informal. Consider replacing it.
Context: ...he database (automatically calls Update Vid Embedding to store vectors in the vecto...
(VID)
[style] ~66-~66: ‘Vid’ is informal. Consider replacing it.
Context: ...tors in the vector database) - Update Vid Embedding: Convert graph vid into vec...
(VID)
[style] ~66-~66: ‘vid’ is informal. Consider replacing it.
Context: ...Update Vid Embedding: Convert graph vid into vectors ### Execution Flow: 1. I...
(VID)
[style] ~74-~74: ‘Vid’ is informal. Consider replacing it.
Context: ...base (this automatically calls Update Vid Embedding to store the vectors in the...
(VID)
[style] ~75-~75: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...the vectors in the vector database). 6. Click the Update Vid Embedding bu...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~75-~75: ‘Vid’ is informal. Consider replacing it.
Context: ...or database). 6. Click the Update Vid Embedding button to vectorize the...
(VID)
[style] ~79-~79: ‘Vid’ is informal. Consider replacing it.
Context: ...(chunks) into vectors, and the Update Vid Embedding button converts graph vid i...
(VID)
[style] ~79-~79: ‘vid’ is informal. Consider replacing it.
Context: ...e Vid Embedding** button converts graph vid into vectors. These vectors are stored ...
(VID)
[duplication] ~109-~109: Possible typo: you repeated a word.
Context: ...nput Fields: - Question: Input the query - Query Prompt: The prompt template used ...
(ENGLISH_WORD_REPEAT_RULE)
[style] ~118-~118: ‘vid’ is informal. Consider replacing it.
Context: ...ly graph-based retrieval (queries graph vid vectors in the vector database and the ...
(VID)
[style] ~136-~136: ‘vid’ is informal. Consider replacing it.
Context: ...zzy match in the vector database (graph vid vector) to retrieve relevant vertices. ...
(VID)
[uncategorized] ~138-~138: Possible missing comma found.
Context: ...nterface, using the matched vertices as entities to convert the question into a Grem...
(AI_HYDRA_LEO_MISSING_COMMA)
content/en/docs/quickstart/hugegraph-ai/_index.md
[uncategorized] ~66-~66: Possible missing preposition found.
Context: ...ost:8001 ### 3.2 Build from Source 1. Start the HugeGraph database, you can run it ...
(AI_HYDRA_LEO_MISSING_TO)
[uncategorized] ~91-~91: Possible missing preposition found.
Context: ...ify hugegraph-llm/pyproject.toml. 5. Start the gradio interactive demo of **Graph ...
(AI_HYDRA_LEO_MISSING_TO)
content/cn/docs/quickstart/hugegraph-ai/quick_start.md
[uncategorized] ~59-~59: 您的意思是“"不"和”？
Context: ...图数据 (1)：** 基于 Schema 从文档中提取图数据，使用图提取提示词头部和分块内容作为提示词 - 加载到图数据库 (2)： 将提取的图数据存储到...
(BU)
🔇 Additional comments (14)
content/cn/docs/quickstart/hugegraph/hugegraph-pd.md (3)
30-35: 代码块语言标记正确
下载并解压示例使用了bash语言标记，命令清晰易读，无需修改。
56-62: YAML 配置块标记正确
主要配置示例已使用yaml语言标记，格式和内容都很清晰。
135-137: bash 代码块标记正确
curl验证示例已使用bash语言标记，展示充分且无需调整。content/cn/docs/quickstart/hugegraph/hugegraph-server.md (4)
311-311: HBase 后端编号更新正确
RocksDB 前移后，HBase 已从 5.1.2 升级为 5.1.3，编号调整合理且文档连贯。
456-456: Memory 后端编号更新正确
Memory 部分已由 5.1.5 调整至 5.1.6，与新增分布式存储节保持一致。
482-482: ScyllaDB 后端编号更新正确
ScyllaDB 已从 5.1.6 调整至 5.1.7，编号无误且顺序合理。
526-526: 示例图创建编号更新正确
示例图创建部分已从 5.1.7 调整为 5.1.8，编号连续且文档结构清晰。content/en/docs/quickstart/hugegraph/_index.md (1)
1-5: Front matter 配置正确
英文文档的title、linkTitle和weight设置符合规范，无需修改。content/en/docs/quickstart/hugegraph/hugegraph-pd.md (1)
1-5:Details
✅ Verification successful
请确认权重与同级文档的一致性
当前weight: 10可能导致在 Quick Start → HugeGraph 目录下排序异常，请核对与其他组件（如 hstore、server 等）的权重值是否符合预期。
🏁 Script executed:
#!/bin/bash # 列出 content/en/docs/quickstart/hugegraph 目录下所有 md 文件的 weight rg -Hn 'content/en/docs/quickstart/hugegraph/.*\.md' -e '^weight:'Length of output: 152
🏁 Script executed:
#!/bin/bash # 使用正确的语法列出 content/en/docs/quickstart/hugegraph 目录下所有 md 文件的 weight rg -Hn '^weight:' content/en/docs/quickstart/hugegraph/*.mdLength of output: 497
HugeGraph-PD 权重无需调整
经检查content/en/docs/quickstart/hugegraph目录下各文件的weight值如下：
hugegraph-server.md：1_index.md：3hugegraph-pd.md：10hugegraph-hstore.md：11PD 的权重 10 已正确排在 server（1）与 hstore（11）之间，顺序符合预期，无需更改。
content/en/docs/quickstart/hugegraph/hugegraph-hstore.md (1)
1-5: Frontmatter 校验通过
YAML frontmatter 完整且格式正确，无需修改。content/cn/docs/quickstart/hugegraph-ai/quick_start.md (1)
1-5: Frontmatter 校验通过
文档头部元数据齐全且正确。content/en/docs/quickstart/hugegraph-ai/_index.md (2)
151-161: 验证初始化方法签名
示例中由LLMs().get_llm()改为LLMs().get_chat_llm()，请确认KgBuilder构造函数已支持该方法，并同步更新 API 文档。
216-217: 校对参数名一致性
示例中使用max_graph_items=30替代旧的max_items，请确保源码或客户端 API 与此参数名称保持一致。content/en/docs/quickstart/hugegraph-ai/quick_start.md (1)
1-5: Frontmatter 校验通过
头部元数据正确，结构清晰。
There was a problem hiding this comment.
Pull Request Overview
This PR restructures the quickstart documentation by adding new index pages in both English and Chinese and enhances the HugeGraph-AI content with updated frontmatter and expanded instructions.
- Added frontmatter for new quickstart sections (Client, Computing, HugeGraph, ToolChain) in English and Chinese
- Updated Chinese HugeGraph-AI index and quick start pages with expanded Docker/source build guides and badges
- Ensured parallel English/Chinese documentation structure and links
Reviewed Changes
Copilot reviewed 30 out of 30 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| content/en/docs/quickstart/computing/_index.md | Added frontmatter for the Computing quickstart |
| content/en/docs/quickstart/client/_index.md | Added frontmatter for the Client quickstart |
| content/cn/docs/quickstart/toolchain/_index.md | Added Chinese frontmatter for the ToolChain section |
| content/cn/docs/quickstart/hugegraph/_index.md | Added Chinese frontmatter for the HugeGraph section |
| content/cn/docs/quickstart/hugegraph-ai/quick_start.md | Added full Chinese quick start content for AI |
| content/cn/docs/quickstart/hugegraph-ai/_index.md | Updated Chinese AI index page with new badges/links |
| content/cn/docs/quickstart/computing/_index.md | Added Chinese frontmatter for the Computing section |
| content/cn/docs/quickstart/client/_index.md | Added Chinese frontmatter for the Client section |
Comments suppressed due to low confidence (2)
content/cn/docs/quickstart/client/_index.md:2
- [nitpick] The title in the Chinese documentation remains in English; consider translating it into Chinese for consistency (e.g., 'HugeGraph 客户端').
title: "HugeGraph Client"
content/cn/docs/quickstart/computing/_index.md:2
- [nitpick] The title in the Chinese documentation remains in English; consider translating it into Chinese for consistency (e.g., 'HugeGraph 计算模块').
title: "HugeGraph Computing"
|
@codecov-ai-reviewer review |
|
On it! We are reviewing the PR and will provide feedback shortly. |
PR DescriptionThis pull request focuses on reorganizing and enhancing the documentation for the HugeGraph project, particularly concerning the integration of Large Language Models (LLMs) via the HugeGraph-AI component. The primary goal is to improve discoverability, clarity, and maintainability of the documentation, making it easier for users to understand and utilize HugeGraph's AI capabilities. Click to see moreKey Technical Changes
Architecture DecisionsThe architectural decisions primarily involve the organization of documentation content. The decision to create separate subdirectories for different components reflects a modular approach, making it easier to maintain and update documentation for specific areas without affecting others. The use of Dependencies and InteractionsThis pull request primarily affects the documentation. However, the updated dependency information and Docker deployment instructions directly relate to the HugeGraph-AI component and its interaction with the core HugeGraph database. The documentation also references external resources such as the HugeGraph-AI repository README and the Litellm documentation, indicating a dependency on these external sources for up-to-date information. Risk Considerations
Notable Implementation Details
|
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (20)
content/en/docs/guides/backup-restore.md (2)
29-29: 确认链接路径正确，但建议修正动词形式
链接已正确指向新的/docs/quickstart/toolchain/hugegraph-tools路径。但“backup”用作动词时应拆分为 “back up”。
使用以下 diff 进行修正：- You can use [hugegraph-tools](/docs/quickstart/toolchain/hugegraph-tools) to backup and restore the graph. + You can use [hugegraph-tools](/docs/quickstart/toolchain/hugegraph-tools) to back up and restore the graph.🧰 Tools
🪛 LanguageTool
[grammar] ~29-~29: The word “backup” is a noun. The verb is spelled with a space.
Context: ...uickstart/toolchain/hugegraph-tools) to backup and restore the graph. #### Backup ``...(NOUN_VERB_CONFUSION)
76-76: 确认链接路径正确，但建议修正动词形式
帮助链接已正确更新。但同样“backup”作为动词时应拆分为 “back up”。
建议应用以下 diff：- For detailed usage of backup and restore commands, please refer to the [hugegraph-tools documentation](/docs/quickstart/toolchain/hugegraph-tools). + For detailed usage of back up and restore commands, please refer to the [hugegraph-tools documentation](/docs/quickstart/toolchain/hugegraph-tools).content/cn/docs/quickstart/hugegraph-ai/quick_start.md (5)
7-7: 精简致谢语
建议删除“欢迎随时更新和改进，谢谢”中的“谢谢”或调整为更正式的用语，以保持专业一致的文档风格。
9-20: 统一标题层级
当前一级标题（# 1. …）与二级/三级标题混用，建议将主要章节（1–5）使用二级标题（##），子模块使用三级标题（###），以保持文档结构清晰。
40-46: 统一输入字段列表格式
建议统一使用- **项**：描述格式，避免在列表中出现混合缩进或额外空格，以提高可读性。
48-57: 按钮命名样式一致性
各按钮名称建议统一加粗或使用“**按钮名称**”格式，保持列表条目风格统一。
63-71: 规范步骤编号格式
建议在“执行流程”中使用统一缩进和数字编号，每行前增加适当缩进，并保持与其他文档一致的风格。content/en/docs/quickstart/hugegraph-ai/_index.md (2)
7-7: 移除多余波浪号
引用说明末尾出现~.，建议删除波浪号，以符合 Markdown 语法并提高可读性。
19-22: 优化有序列表缩进
在段落后直接使用数字列表时，请保持列表项与段落同级缩进，并使用一致格式，避免解析歧义。content/cn/docs/quickstart/hugegraph-ai/_index.md (11)
7-10: 优化块引用语法与格式
- 删除第 8 行无
>的空行或在其前添加>，避免块引用中出现空行。- “定期更新和同步” 建议改为 “定期地更新和同步” 以符合中文副词修饰习惯。
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
8-8: Blank line inside blockquote
null(MD028, no-blanks-blockquote)
12-14: 审校概述段落表达
首句已清晰说明项目定位，第二句“众所周知，图系统可以帮助大模型解决时效性和幻觉等挑战，而大模型可以帮助图系统解决成本相关的问题。”表述略显冗长，可精简为“图系统可解决大模型的时效性与幻觉问题，大模型可降低图系统的成本”。
29-38: 精简 Docker 部署标题重复
“#### 3.1 Docker部署” 与下方**Docker部署**重复，建议移除粗体或将标题降级，避免重复。
52-56: 补充容器内运行上下文
第二部分直接执行./app.dist/app.bin，建议在命令前说明“切换到应用安装目录”，以免用户不清楚当前路径。
57-57: 将访问链接代码化或超链接化
http://localhost:8001建议用`http://localhost:8001`或[http://localhost:8001](http://localhost:8001)包裹，以符合 Markdown 规范。🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
57-57: Bare URL used
null(MD034, no-bare-urls)
59-67: 第 3.2 节第 1 步说明完善
“1. 启动HugeGraph数据库” 建议补充“在本地或 Docker 环境中运行”，并确保docker run命令的缩进与前后保持一致。
94-94: 步骤编号与格式统一
“6. 进入项目目录” 与其他步骤样式略有不同，建议统一列表缩进或将序号段落改为二级标题。
99-106: Graph RAG 演示示例整合
示例中首次运行与再次运行的命令重复，可合并为一个代码块，并在前面注明“在宿主机或容器中运行”。🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
99-99: Bare URL used
null(MD034, no-bare-urls)
108-110: 移除英文与 Emoji 标记
“(🚧ing)” 建议替换为中文 “（进行中）” 或删除，以保持文档语言环境一致。🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
108-108: Bare URL used
null(MD034, no-bare-urls)
119-119: Litellm 官方文档链接注释
[litellm.ai](https://docs.litellm.ai/docs/providers)可注明为 “Litellm 官方提供商配置文档”，并建议锁定版本。
123-126: 规范强调语法
第 11 步中使用__可选__建议替换为**可选**，符合 Markdown 推荐的强强调写法。🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
123-123: Strong style
Expected: asterisk; Actual: underscore(MD050, strong-style)
123-123: Strong style
Expected: asterisk; Actual: underscore(MD050, strong-style)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (36)
content/cn/docs/changelog/hugegraph-0.2-release-notes.md(1 hunks)content/cn/docs/clients/gremlin-console.md(1 hunks)content/cn/docs/clients/hugegraph-client.md(1 hunks)content/cn/docs/clients/restful-api/_index.md(1 hunks)content/cn/docs/clients/restful-api/task.md(1 hunks)content/cn/docs/guides/architectural.md(1 hunks)content/cn/docs/guides/backup-restore.md(2 hunks)content/cn/docs/introduction/README.md(1 hunks)content/cn/docs/performance/hugegraph-loader-performance.md(1 hunks)content/cn/docs/quickstart/client/_index.md(1 hunks)content/cn/docs/quickstart/computing/hugegraph-computer.md(1 hunks)content/cn/docs/quickstart/computing/hugegraph-vermeer.md(1 hunks)content/cn/docs/quickstart/hugegraph-ai/_index.md(4 hunks)content/cn/docs/quickstart/hugegraph-ai/quick_start.md(1 hunks)content/cn/docs/quickstart/hugegraph/_index.md(1 hunks)content/cn/docs/quickstart/hugegraph/hugegraph-hstore.md(1 hunks)content/cn/docs/quickstart/hugegraph/hugegraph-pd.md(1 hunks)content/cn/docs/quickstart/hugegraph/hugegraph-server.md(3 hunks)content/cn/docs/quickstart/toolchain/_index.md(1 hunks)content/cn/docs/quickstart/toolchain/hugegraph-hubble.md(3 hunks)content/cn/docs/quickstart/toolchain/hugegraph-loader.md(2 hunks)content/cn/docs/quickstart/toolchain/hugegraph-tools.md(1 hunks)content/en/docs/clients/gremlin-console.md(1 hunks)content/en/docs/clients/hugegraph-client.md(1 hunks)content/en/docs/clients/restful-api/_index.md(1 hunks)content/en/docs/clients/restful-api/task.md(1 hunks)content/en/docs/contribution-guidelines/hugegraph-server-idea-setup.md(2 hunks)content/en/docs/guides/architectural.md(1 hunks)content/en/docs/guides/backup-restore.md(2 hunks)content/en/docs/introduction/README.md(1 hunks)content/en/docs/quickstart/client/hugegraph-client.md(2 hunks)content/en/docs/quickstart/hugegraph-ai/_index.md(5 hunks)content/en/docs/quickstart/hugegraph-studio.md(1 hunks)content/en/docs/quickstart/hugegraph/hugegraph-server.md(2 hunks)content/en/docs/quickstart/toolchain/hugegraph-hubble.md(2 hunks)content/en/docs/quickstart/toolchain/hugegraph-loader.md(2 hunks)
✅ Files skipped from review due to trivial changes (26)
- content/cn/docs/quickstart/toolchain/hugegraph-tools.md
- content/cn/docs/clients/restful-api/task.md
- content/cn/docs/quickstart/toolchain/hugegraph-loader.md
- content/en/docs/clients/hugegraph-client.md
- content/cn/docs/quickstart/hugegraph/hugegraph-pd.md
- content/en/docs/quickstart/toolchain/hugegraph-hubble.md
- content/cn/docs/quickstart/computing/hugegraph-computer.md
- content/cn/docs/changelog/hugegraph-0.2-release-notes.md
- content/cn/docs/performance/hugegraph-loader-performance.md
- content/cn/docs/quickstart/computing/hugegraph-vermeer.md
- content/cn/docs/guides/backup-restore.md
- content/en/docs/quickstart/hugegraph-studio.md
- content/en/docs/clients/gremlin-console.md
- content/en/docs/clients/restful-api/_index.md
- content/en/docs/contribution-guidelines/hugegraph-server-idea-setup.md
- content/cn/docs/clients/hugegraph-client.md
- content/en/docs/quickstart/client/hugegraph-client.md
- content/en/docs/quickstart/toolchain/hugegraph-loader.md
- content/en/docs/quickstart/hugegraph/hugegraph-server.md
- content/cn/docs/quickstart/hugegraph/hugegraph-server.md
- content/cn/docs/quickstart/hugegraph/hugegraph-hstore.md
- content/en/docs/guides/architectural.md
- content/cn/docs/clients/gremlin-console.md
- content/en/docs/clients/restful-api/task.md
- content/cn/docs/quickstart/toolchain/hugegraph-hubble.md
- content/en/docs/introduction/README.md
🚧 Files skipped from review as they are similar to previous changes (3)
- content/cn/docs/quickstart/client/_index.md
- content/cn/docs/quickstart/hugegraph/_index.md
- content/cn/docs/quickstart/toolchain/_index.md
🧰 Additional context used
🪛 LanguageTool
content/en/docs/quickstart/hugegraph-ai/_index.md
[uncategorized] ~66-~66: Possible missing preposition found.
Context: ...ost:8001 ### 3.2 Build from Source 1. Start the HugeGraph database, you can run it ...
(AI_HYDRA_LEO_MISSING_TO)
[uncategorized] ~91-~91: Possible missing preposition found.
Context: ...ify hugegraph-llm/pyproject.toml. 5. Start the gradio interactive demo of **Graph ...
(AI_HYDRA_LEO_MISSING_TO)
content/cn/docs/guides/architectural.md
[uncategorized] ~20-~20: 数词与名词之间一般应存在量词，可能缺少量词。
Context: ...uickstart/toolchain/hugegraph-hubble/): 一站式可视化分析平台，平台涵盖了从数据建模，到数据快速导入，再到数据的在线、离线分析...
(wa5)
content/cn/docs/introduction/README.md
[uncategorized] ~56-~56: 数词与名词之间一般应存在量词，可能缺少量词。
Context: ...Graph-Hubble 是 HugeGraph 的 Web 可视化管理平台，一站式可视化分析平台，平台涵盖了从数据建模，到数据快速导入，再到数据的在线、离线分析...
(wa5)
content/cn/docs/quickstart/hugegraph-ai/_index.md
[uncategorized] ~114-~114: 动词的修饰一般为‘形容词（副词）+地+动词’。您的意思是否是：最新"地"更改
Context: ...存到配置文件中。你也可以直接修改文件而无需重启应用程序；只需刷新页面即可加载最新的更改。 （可选）要重新生成配置文件，您可以将 `config.gener...
(wb4)
content/cn/docs/quickstart/hugegraph-ai/quick_start.md
[uncategorized] ~59-~59: 您的意思是“"不"和”？
Context: ...图数据 (1)：** 基于 Schema 从文档中提取图数据，使用图提取提示词头部和分块内容作为提示词 - 加载到图数据库 (2)： 将提取的图数据存储到...
(BU)
content/en/docs/guides/backup-restore.md
[grammar] ~29-~29: The word “backup” is a noun. The verb is spelled with a space.
Context: ...uickstart/toolchain/hugegraph-tools) to backup and restore the graph. #### Backup ``...
(NOUN_VERB_CONFUSION)
🪛 markdownlint-cli2 (0.17.2)
content/en/docs/quickstart/hugegraph-ai/_index.md
8-8: Blank line inside blockquote
null
(MD028, no-blanks-blockquote)
38-38: Unordered list indentation
Expected: 0; Actual: 3
(MD007, ul-indent)
39-39: Unordered list indentation
Expected: 0; Actual: 3
(MD007, ul-indent)
40-40: Unordered list indentation
Expected: 2; Actual: 5
(MD007, ul-indent)
42-42: Unordered list indentation
Expected: 2; Actual: 5
(MD007, ul-indent)
44-44: Unordered list indentation
Expected: 0; Actual: 3
(MD007, ul-indent)
49-49: Unordered list indentation
Expected: 0; Actual: 3
(MD007, ul-indent)
54-54: Unordered list indentation
Expected: 0; Actual: 3
(MD007, ul-indent)
62-62: Unordered list indentation
Expected: 0; Actual: 3
(MD007, ul-indent)
62-62: Bare URL used
null
(MD034, no-bare-urls)
91-91: Bare URL used
null
(MD034, no-bare-urls)
107-107: Strong style
Expected: asterisk; Actual: underscore
(MD050, strong-style)
107-107: Strong style
Expected: asterisk; Actual: underscore
(MD050, strong-style)
111-111: Strong style
Expected: asterisk; Actual: underscore
(MD050, strong-style)
111-111: Strong style
Expected: asterisk; Actual: underscore
(MD050, strong-style)
content/cn/docs/quickstart/hugegraph-ai/_index.md
8-8: Blank line inside blockquote
null
(MD028, no-blanks-blockquote)
57-57: Bare URL used
null
(MD034, no-bare-urls)
99-99: Bare URL used
null
(MD034, no-bare-urls)
108-108: Bare URL used
null
(MD034, no-bare-urls)
123-123: Strong style
Expected: asterisk; Actual: underscore
(MD050, strong-style)
123-123: Strong style
Expected: asterisk; Actual: underscore
(MD050, strong-style)
🔇 Additional comments (19)
content/cn/docs/clients/restful-api/_index.md (1)
10-10:Details
❓ Verification inconclusive
检查Swagger UI链接路径
请确认目标路径/cn/docs/quickstart/hugegraph/hugegraph-server#swaggerui-example已经同步到对应的文件目录，并且导航中存在该页面。可以运行以下脚本验证链接文件是否存在：
🏁 Script executed:
#!/bin/bash # Verify the target markdown exists rg -l "# Swagger UI" -g "content/cn/docs/quickstart/hugegraph/hugegraph-server.md"Length of output: 82
检查 Swagger UI 链接路径
脚本未能在
content/cn/docs/quickstart/hugegraph/hugegraph-server.md中找到对应的标题或锚点，请手动确认：
- 文件是否存在于该路径
- 文件内是否包含
# Swagger UI或swaggerui-example锚点- 如不存在，请添加对应标题/锚点或更新链接至正确位置
验证脚本示例：
rg -n "swaggerui-example" -g "content/cn/docs/quickstart/hugegraph/hugegraph-server.md"content/cn/docs/introduction/README.md (1)
48-55:Details
✅ Verification successful
确认Quickstart模块链接一致性
更新后的链接已指向新的/cn/docs/quickstart/hugegraph/hugegraph-server、/cn/docs/quickstart/client/hugegraph-client、/cn/docs/quickstart/toolchain/hugegraph-loader、/cn/docs/quickstart/toolchain/hugegraph-hubble等目录，请确保与实际文件结构一致，且中英文版本均已同步。
🏁 Script executed:
#!/bin/bash rg -l "_index.md" -g "content/cn/docs/quickstart/*"Length of output: 51
请进一步验证
content/cn/docs/quickstart目录下的实际文件列表，以确认链接目标是否存在并正确命名。执行：
🏁 Script executed:
#!/bin/bash find content/cn/docs/quickstart -type fLength of output: 969
请进一步验证英文版本
content/en/docs/quickstart目录下的实际文件列表，以确认中英文链接均已同步。执行：
🏁 Script executed:
#!/bin/bash find content/en/docs/quickstart -type fLength of output: 969
Quickstart 模块链接一致校验通过
已在中英文文档中确认以下路径均存在且命名一致，无需修改：
/cn/docs/quickstart/hugegraph/hugegraph-server⇄content/cn/docs/quickstart/hugegraph/hugegraph-server.md
对应英文：content/en/docs/quickstart/hugegraph/hugegraph-server.md/cn/docs/quickstart/client/hugegraph-client⇄content/cn/docs/quickstart/client/hugegraph-client.md
对应英文：content/en/docs/quickstart/client/hugegraph-client.md/cn/docs/quickstart/toolchain/hugegraph-loader⇄content/cn/docs/quickstart/toolchain/hugegraph-loader.md
对应英文：content/en/docs/quickstart/toolchain/hugegraph-loader.md/cn/docs/quickstart/toolchain/hugegraph-hubble⇄content/cn/docs/quickstart/toolchain/hugegraph-hubble.md
对应英文：content/en/docs/quickstart/toolchain/hugegraph-hubble.mdcontent/cn/docs/quickstart/hugegraph-ai/quick_start.md (2)
1-5: 校验文档元数据完整性
前置元数据已包含title、linkTitle与weight，保证文档在导航中的正确排序和展示。
26-38: 校对 Mermaid 图表语法与标注
请确保流程图内节点标识与章节描述一致，并在流程文字中增加必要换行或注释，以提高可读性和渲染效果。如需验证 Mermaid 渲染，可在本地使用 VSCode 插件或在线编辑器预览。
content/en/docs/quickstart/hugegraph-ai/_index.md (5)
2-2: 确认前置元数据更改
标题已更新为 “Explore with HugeGraph-AI”，请检查导航侧边栏是否已同步更新该标题。
9-9: 检查 DeepWiki 徽章链接有效性
请验证外部徽章链接是否正常渲染并可访问，确保读者可点击跳转。可以使用
curl -I https://deepwiki.com/badge.svg检查 HTTP 响应状态。
28-30: 验证环境依赖版本描述
python 3.10+ (not tested in 3.12)、hugegraph-server 1.3+ (better to use 1.5+)、uv 0.7+描述清晰合理，符合项目要求。
40-44: Docker 部署说明审核通过
镜像名称与操作命令清晰，拉取与运行步骤完整，符合最佳实践。🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
40-40: Unordered list indentation
Expected: 2; Actual: 5(MD007, ul-indent)
42-42: Unordered list indentation
Expected: 2; Actual: 5(MD007, ul-indent)
44-44: Unordered list indentation
Expected: 0; Actual: 3(MD007, ul-indent)
108-108: 验证工具链链接路径
请检查该链接/docs/quickstart/toolchain/hugegraph-hubble/#21-use-docker-convenient-for-testdev是否在英文文档中可用，并指向正确锚点。content/cn/docs/quickstart/hugegraph-ai/_index.md (10)
2-4: 检查导航元数据一致性
请与英文版文档保持title、linkTitle和weight顺序一致，确保侧边栏展示逻辑正确。建议运行脚本验证所有 quickstart 页面
weight属性是否唯一且有序。
16-19: 确认用例列表格式
列表项使用数字序号正确，格式规范，无需修改。
22-25: 环境要求区块一致性
> [!IMPORTANT]下的各项前均已添加>，样式一致，可保留。
41-43: 拉取镜像命令示例正确
docker pull示例符合最佳实践，无需调整。
46-48: 检查端口映射冲突
示例中两个容器均映射至主机8001:8001，启动时会冲突。请说明需分开运行或使用不同端口。
68-72: UV 安装方式说明
已给出curl | sh示例，建议再列出pip install uv备选方案，并说明版本锁定方式。
74-84: 克隆与虚拟环境路径校验
- 建议
git clone时加--depth 1提升效率。- 确认
cd incubator-hugegraph-ai/hugegraph-llm路径与实际仓库结构一致。
87-87: 验证文档链接路径有效性
[hugegraph-python-client](../hugegraph-python-client)与[hugegraph_llm](src/hugegraph_llm)相对路径可能无法在网站中解析，建议改为指向 GitHub 或站点文档页面的绝对链接。
113-118: 配置文件生成说明完善
自动生成与更新命令已涵盖，建议在每个代码块开头标注bash，并重申默认输出路径。🧰 Tools
🪛 LanguageTool
[uncategorized] ~114-~114: 动词的修饰一般为‘形容词（副词）+地+动词’。您的意思是否是：最新"地"更改
Context: ...存到配置文件中。你也可以直接修改文件而无需重启应用程序；只需刷新页面即可加载最新的更改。 （可选）要重新生成配置文件，您可以将 `config.gener...(wb4)
121-121: Hubble 仪表板链接检查
请验证/cn/docs/quickstart/toolchain/hugegraph-hubble/#21-use-docker-convenient-for-testdev在站点中是否存在对应锚点及页面。
|
@codecov-ai-reviewer review |
|
On it! We are reviewing the PR and will provide feedback shortly. |
PR DescriptionThis pull request reorganizes the HugeGraph documentation, specifically the quick start guides, into a more logical and maintainable structure. The primary goal is to improve discoverability and navigation for new users by grouping related components together. Click to see moreKey Technical ChangesThe key technical change is the restructuring of the file system to categorize quick start guides into Architecture DecisionsThe main architectural decision is to group the quick start guides based on the type of component they describe. This promotes a clearer understanding of the HugeGraph ecosystem and simplifies future maintenance and additions. The new structure also aligns better with the overall project architecture. Dependencies and InteractionsThis change primarily affects internal documentation links. It depends on the Hugo static site generator to correctly resolve the updated links. There are no direct dependencies on other parts of the HugeGraph system, but the documentation serves as a crucial entry point for users interacting with those systems. Risk ConsiderationsThe primary risk is broken links if the migration is not performed correctly. To mitigate this, thorough testing of all internal links is essential after the changes are deployed. Additionally, any external links pointing to the old documentation structure will need to be updated. Notable Implementation DetailsThe implementation involved a large number of file renames and moves, as well as link updates across multiple files. Special attention was given to ensuring that the language-specific prefixes ( |
![codecov-ai[bot]](https://avatars.githubusercontent.com/in/797565?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
♻️ Duplicate comments (3)
content/cn/docs/quickstart/hugegraph-ai/_index.md (1)
29-38: 完善镜像版本兼容性说明
当前仅提到“最新”镜像标签，未说明与hugegraph-server的对应版本关系。建议在镜像列表中注明推荐标签与服务端版本的兼容性。content/en/docs/quickstart/hugegraph-ai/_index.md (2)
26-31: 补充系统资源要求环境要求节已列出 Python、HugeGraph 版本及 uv 版本，但未说明最小 RAM/CPU。与先前评论一致，建议补充系统资源信息：
## 2. Environment Requirements > [!IMPORTANT] > - python 3.10+ (not tested in 3.12) > - hugegraph-server 1.3+ (better to use 1.5+) > - uv 0.7+ > - Minimum 4GB RAM recommended > - 2+ CPU cores for optimal performance
46-53: 补充持久化数据卷挂载当前 Docker run 命令仅挂载
.env，建议同时挂载数据目录以保证持久化：- docker run -it --name rag -v path2project/hugegraph-llm/.env:/home/work/hugegraph-llm/.env -p 8001:8001 hugegraph/rag bash + docker run -it --name rag \ + -v $(pwd)/hugegraph-llm/.env:/home/work/hugegraph-llm/.env \ + -v $(pwd)/data:/home/work/hugegraph-llm/data \ + -p 8001:8001 hugegraph/rag bash
🧹 Nitpick comments (6)
content/cn/docs/quickstart/hugegraph-ai/_index.md (2)
7-9: 移除 blockquote 行尾多余波浪号
第7行末尾的同步~。多余波浪号会影响渲染，请删除。
41-47: 增强 Docker 命令示例通用性
- 建议使用
$(pwd)或环境变量替代占位符path2project，避免路径错误。- 可补充端口冲突或内存不足等常见问题的处理方法提示。
content/en/docs/quickstart/hugegraph-ai/_index.md (4)
66-71: 修正英文表述：添加缺失介词原文“Start the HugeGraph database, you can run it via Docker:”缺少介词，建议：
- 1. Start the HugeGraph database, you can run it via Docker: + 1. To start the HugeGraph database, you can run it via Docker:🧰 Tools
🪛 LanguageTool
[uncategorized] ~66-~66: Possible missing preposition found.
Context: ...ost:8001 ### 3.2 Build from Source 1. Start the HugeGraph database, you can run it ...(AI_HYDRA_LEO_MISSING_TO)
75-76: 修正英文表述：调整时态原文“You could try pipx or pip to install uv when meet network issues”应改为：
- You could try pipx or pip to install uv when meet network issues + You could try pipx or pip to install uv when encountering network issues
106-106: 修正英文表述：动词形式“Litellm support multi-LLM provider”应为“Litellm supports”以匹配第三人称单数：
- Note: `Litellm` support multi-LLM provider + Note: `Litellm` supports multi-LLM providers
162-162: UML 图片 alt 文本优化建议将 alt 文本与图片含义对应，调整为：
-  + 
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (13)
content/cn/docs/quickstart/hugegraph-ai/_index.md(4 hunks)content/en/docs/quickstart/client/_index.md(1 hunks)content/en/docs/quickstart/client/hugegraph-client.md(2 hunks)content/en/docs/quickstart/computing/hugegraph-computer.md(1 hunks)content/en/docs/quickstart/computing/hugegraph-vermeer.md(1 hunks)content/en/docs/quickstart/hugegraph-ai/_index.md(5 hunks)content/en/docs/quickstart/hugegraph/_index.md(1 hunks)content/en/docs/quickstart/hugegraph/hugegraph-hstore.md(1 hunks)content/en/docs/quickstart/hugegraph/hugegraph-pd.md(1 hunks)content/en/docs/quickstart/hugegraph/hugegraph-server.md(3 hunks)content/en/docs/quickstart/toolchain/_index.md(1 hunks)content/en/docs/quickstart/toolchain/hugegraph-hubble.md(3 hunks)content/en/docs/quickstart/toolchain/hugegraph-tools.md(1 hunks)
✅ Files skipped from review due to trivial changes (5)
- content/en/docs/quickstart/toolchain/hugegraph-tools.md
- content/en/docs/quickstart/computing/hugegraph-computer.md
- content/en/docs/quickstart/hugegraph/hugegraph-hstore.md
- content/en/docs/quickstart/computing/hugegraph-vermeer.md
- content/en/docs/quickstart/hugegraph/hugegraph-pd.md
🚧 Files skipped from review as they are similar to previous changes (5)
- content/en/docs/quickstart/client/_index.md
- content/en/docs/quickstart/toolchain/_index.md
- content/en/docs/quickstart/toolchain/hugegraph-hubble.md
- content/en/docs/quickstart/client/hugegraph-client.md
- content/en/docs/quickstart/hugegraph/hugegraph-server.md
🧰 Additional context used
🪛 LanguageTool
content/en/docs/quickstart/hugegraph-ai/_index.md
[uncategorized] ~66-~66: Possible missing preposition found.
Context: ...ost:8001 ### 3.2 Build from Source 1. Start the HugeGraph database, you can run it ...
(AI_HYDRA_LEO_MISSING_TO)
[uncategorized] ~91-~91: Possible missing preposition found.
Context: ...ify hugegraph-llm/pyproject.toml. 5. Start the gradio interactive demo of **Graph ...
(AI_HYDRA_LEO_MISSING_TO)
content/cn/docs/quickstart/hugegraph-ai/_index.md
[uncategorized] ~114-~114: 动词的修饰一般为‘形容词（副词）+地+动词’。您的意思是否是：最新"地"更改
Context: ...存到配置文件中。你也可以直接修改文件而无需重启应用程序；只需刷新页面即可加载最新的更改。 （可选）要重新生成配置文件，您可以将 `config.gener...
(wb4)
🔇 Additional comments (30)
content/en/docs/quickstart/hugegraph/_index.md (1)
1-5: Front matter 配置正确
已为该文档添加title、linkTitle和weight，与其他 Quickstart 节点保持一致。content/cn/docs/quickstart/hugegraph-ai/_index.md (16)
2-4: 验证 frontmatter 与英文版本一致
请确认title,linkTitle,weight与英文文档保持同步，且weight: 2在导航中可正确排序。
12-19: 概述部分表述清晰
段落结构和要点描述恰当，序号列表可考虑在数字后统一加句号或全角符号以保持一致性。
23-25: 环境要求说明合理
已明确列出 Python、HugeGraph Server 及 uv 版本，覆盖了核心依赖。
52-55: Docker RAG 演示命令正确
针对两种镜像的启动命令描述精准，可正常启动 Graph RAG 演示。
59-66: 源码构建流程清晰
“#### 3.2 从源码构建” 标题与后续步骤无误，整体结构条理清晰。
68-72: UV 安装示例完善
提供了官方脚本及 pipx/pip 替代方案，能够兼容网络受限或环境无 curl 的情况。
74-74: 克隆项目步骤准确
git clone https://github.com/apache/incubator-hugegraph-ai.git无误。
79-85: 依赖环境配置合理
使用uv venv创建虚拟环境并安装可编辑包，且对网络问题提供了修改pyproject.toml的建议。
87-92: 安装客户端示例可用
本地安装hugegraph-python-client与hugegraph_llm的命令与项目结构一致。
96-96: 项目目录切换命令正确
cd ./hugegraph-llm/src与上下文一致。
101-106: Graph RAG 演示运行命令一致
python -m hugegraph_llm.demo.rag_demo.app及其--host/--port参数说明清晰，可灵活调整。
110-110: Text2Gremlin 演示命令准确
python3 -m hugegraph_llm.demo.gremlin_generate_web_demo对应脚本位置明确。
115-118: 配置文件重新生成命令明确
提供了python -m hugegraph_llm.config.generate --update使用示例，便于在无需重启的情况下刷新配置。
119-119: 多提供商支持说明完整
已注明Litellm支持多 LLM 提供商并提供了官方链接。
121-121: Hubble 仪表板说明充分
可选使用hugegraph-hubble仪表板并提供了链接和运行方式指导。
123-123: 离线下载 NLTK 停用词步骤正确
下载脚本路径python ./hugegraph_llm/operators/common_op/nltk_helper.py无误。content/en/docs/quickstart/hugegraph-ai/_index.md (13)
2-5: 前言信息校验通过标题（title）、链接标题（linkTitle）和权重（weight）配置符合文档规范，前置信息无其他异常。
9-9: 引用提示文本检查“AI summarizes the project documentation:” 调用 DeepWiki 徽章展示清晰，可通过。
11-17: 概述章节表述校验“## 1. Summary” 及其后段落逻辑清晰，表达准确，无需修改。
19-25: 用例列表格式确认3 个用例列表符合 Markdown 规范且表述完整，可通过。
32-37: 准备章节结构无误“## 3. Preparation” 及其子节 Docker 标题层级合理，内容组织得当。
56-61: Graph RAG Demo 启动命令确认示例命令覆盖两种镜像情形，指令、注释无误，可通过。
81-87: 克隆与虚拟环境配置检查代码示例命令完整，步骤清晰，符合构建流程。
104-104: 配置生成命令无误
python -m hugegraph_llm.config.generate --update示例清晰，可通过。
110-110: HugeGraph-Hubble 可选项链接校验链接地址和描述准确，示例无需修改。
115-116: 提示块格式确认TIP 块使用正确，内容指向
quick_start.md，可通过。
137-137: 示例图片展示
用于直观示例，alt 文本可读性良好。
152-152: 代码示例函数名更新
get_chat_llm()已替换get_llm()，示例同步到最新版本，正确。
216-216: 参数名称更新正确
max_graph_items与示例一致，参数改动在示例中已正确反映。
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (5)
content/en/docs/quickstart/hugegraph-ai/_index.md (5)
7-10: 优化 Blockquote 语法及表达
- 删除 Blockquote 内部多余空行以满足 MD028 规范。
- 建议将 “and the official website regularly is updated and synchronized” 改为 “and please note that the official website is regularly updated and synchronized.”
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
8-8: Blank line inside blockquote
null(MD028, no-blanks-blockquote)
38-53: 修复列表缩进不一致当前 Docker 部署步骤中多处无序列表缩进偏移不一致，需统一顶级列表（
-与行首对齐）及子列表（缩进两个空格）格式，例如：- - Ensure you have Docker installed + - Ensure you have Docker installed + - We provide two container images: + - **Image 1**: [hugegraph/rag]... + - **Image 2**: [hugegraph/rag-bin]...🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
38-38: Unordered list indentation
Expected: 0; Actual: 3(MD007, ul-indent)
39-39: Unordered list indentation
Expected: 0; Actual: 3(MD007, ul-indent)
40-40: Unordered list indentation
Expected: 2; Actual: 5(MD007, ul-indent)
42-42: Unordered list indentation
Expected: 2; Actual: 5(MD007, ul-indent)
44-44: Unordered list indentation
Expected: 0; Actual: 3(MD007, ul-indent)
49-49: Unordered list indentation
Expected: 0; Actual: 3(MD007, ul-indent)
66-77: 优化语法：添加缺失介词修正 “1. Start the HugeGraph database, you can run it via …” 为更通顺的表达，如：
- 1. Start the HugeGraph database, you can run it via Docker: + 1. To start the HugeGraph database, run it via Docker:🧰 Tools
🪛 LanguageTool
[uncategorized] ~66-~66: Possible missing preposition found.
Context: ...ost:8001 ### 3.2 Build from Source 1. Start the HugeGraph database, you can run it ...(AI_HYDRA_LEO_MISSING_TO)
91-94: 替换裸 URL 为链接避免 MarkdownLint MD034 报错，将裸 URL 替换为链接格式，例如：
- then open http://127.0.0.1:8001 in your browser. + then open [http://127.0.0.1:8001](http://127.0.0.1:8001) in your browser.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
91-91: Bare URL used
null(MD034, no-bare-urls)
107-111: 统一强制样式：使用星号替换下划线“(Optional)” 中的下划线应改为星号以满足 MD050 规范，例如：
- (__Optional__) You could use + (**Optional**) You could use🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
107-107: Strong style
Expected: asterisk; Actual: underscore(MD050, strong-style)
107-107: Strong style
Expected: asterisk; Actual: underscore(MD050, strong-style)
111-111: Strong style
Expected: asterisk; Actual: underscore(MD050, strong-style)
111-111: Strong style
Expected: asterisk; Actual: underscore(MD050, strong-style)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
content/en/docs/quickstart/hugegraph-ai/_index.md(5 hunks)
🧰 Additional context used
🪛 LanguageTool
content/en/docs/quickstart/hugegraph-ai/_index.md
[uncategorized] ~66-~66: Possible missing preposition found.
Context: ...ost:8001 ### 3.2 Build from Source 1. Start the HugeGraph database, you can run it ...
(AI_HYDRA_LEO_MISSING_TO)
🪛 markdownlint-cli2 (0.17.2)
content/en/docs/quickstart/hugegraph-ai/_index.md
8-8: Blank line inside blockquote
null
(MD028, no-blanks-blockquote)
38-38: Unordered list indentation
Expected: 0; Actual: 3
(MD007, ul-indent)
39-39: Unordered list indentation
Expected: 0; Actual: 3
(MD007, ul-indent)
40-40: Unordered list indentation
Expected: 2; Actual: 5
(MD007, ul-indent)
42-42: Unordered list indentation
Expected: 2; Actual: 5
(MD007, ul-indent)
44-44: Unordered list indentation
Expected: 0; Actual: 3
(MD007, ul-indent)
49-49: Unordered list indentation
Expected: 0; Actual: 3
(MD007, ul-indent)
54-54: Unordered list indentation
Expected: 0; Actual: 3
(MD007, ul-indent)
62-62: Unordered list indentation
Expected: 0; Actual: 3
(MD007, ul-indent)
62-62: Bare URL used
null
(MD034, no-bare-urls)
91-91: Bare URL used
null
(MD034, no-bare-urls)
107-107: Strong style
Expected: asterisk; Actual: underscore
(MD050, strong-style)
107-107: Strong style
Expected: asterisk; Actual: underscore
(MD050, strong-style)
111-111: Strong style
Expected: asterisk; Actual: underscore
(MD050, strong-style)
111-111: Strong style
Expected: asterisk; Actual: underscore
(MD050, strong-style)
🔇 Additional comments (2)
content/en/docs/quickstart/hugegraph-ai/_index.md (2)
2-4: 确保导航权重一致及多语言文件同步PR 中新增了
weight: 2用于侧边栏排序，请确认 English 与 Chinese 版导航中的权重设置保持一致，且在所有相关章节中没有冲突。
214-217: 确认方法签名：query_graphdb参数名示例中使用
max_graph_items=30，请核对代码实现是否已更新该参数名（原来为max_items），确保文档与实际方法签名一致。
There was a problem hiding this comment.
Actionable comments posted: 4
🔭 Outside diff range comments (1)
content/cn/docs/quickstart/hugegraph-ai/_index.md (1)
155-155:⚠️ Potential issue更新示例代码接口
示例中仍在使用
LLMs().get_llm()，请同步为最新的get_chat_llm()接口：-builder = KgBuilder(LLMs().get_llm()) +builder = KgBuilder(LLMs().get_chat_llm())
♻️ Duplicate comments (1)
content/en/docs/quickstart/hugegraph-ai/quick_start.md (1)
26-31: 补充系统资源需求环境要求部分缺少最低系统资源说明（如内存、CPU 核心数），之前已有相同建议，请在此处添加，如：
> - Minimum 4 GB RAM (recommended) > - At least 2 CPU cores
🧹 Nitpick comments (20)
content/en/docs/quickstart/hugegraph/_index.md (1)
1-5: 建议添加 description 字段
为了提升页面的可发现性和一致性，建议在 frontmatter 中补充 description 字段，对本页内容做简要说明，例如：description: "HugeGraph OLTP 快速入门指南，涵盖服务器部署、配置与使用示例。"content/en/docs/quickstart/computing/hugegraph-computer.md (5)
9-9: 改善英语表达与格式
建议在 “Kubernetes(K8s)” 与括号之间添加空格，并将 “one of the biggest differences” 改为更简洁的 “a key distinction”，示例如下：-The [`HugeGraph-Computer`](https://github.com/apache/incubator-hugegraph-computer) is a distributed graph processing system for HugeGraph (OLAP). It is an implementation of [Pregel](https://kowshik.github.io/JPregel/pregel_paper.pdf). It runs on a Kubernetes(K8s) framework.(It focuses on supporting graph data volumes of hundreds of billions to trillions, using disk for sorting and acceleration, which is one of the biggest differences from Vermeer) +The [`HugeGraph-Computer`](https://github.com/apache/incubator-hugegraph-computer) is a distributed graph processing system for HugeGraph (OLAP). It is an implementation of [Pregel](https://kowshik.github.io/JPregel/pregel_paper.pdf). It runs on a Kubernetes (K8s) framework. It is a key distinction that it focuses on supporting graph data volumes of hundreds of billions to trillions by using disk-based sorting and acceleration, unlike Vermeer.🧰 Tools
🪛 LanguageTool
[style] ~9-~9: The word ‘biggest’ tends to be overused. Consider an alternative.
Context: ...g and acceleration, which is one of the biggest differences from Vermeer) ### Features - Support ...(BIG_DIFFERENCE)
14-14: 修正多余介词
将 “just like as in a single server” 改为 “just like in a single server”，去掉冗余的 “as”：-You just need to focus on vertex-only processing just like as in a single server, without worrying about message transfer and memory/storage management. +You just need to focus on vertex-only processing just like in a single server, without worrying about message transfer and memory/storage management.
85-85: 优化参考链接描述
将 “More reference:” 改为 “For more information, see:” 更符合常见文档用语：-If the OLAP index is not enabled, it needs to be enabled. More reference: [modify-graphs-read-mode] +If the OLAP index is not enabled, it needs to be enabled. For more information, see: [modify-graphs-read-mode]
203-203: 修改标题词汇
“Built-In algorithms document” 建议改为 “Built-In Algorithms” 或 “Built-In Algorithms Documentation” 以提升可读性：-## 4. Built-In algorithms document +## 4. Built-In Algorithms
205-228: 调整算法列表标题层级与项目符号
- 将
###### Centrality Algorithm:等深度过高的六级标题改为四级####；- 统一将
*项目符号替换为-，与文档其他部分保持一致。-###### Centrality Algorithm: +#### Centrality Algorithm: -* PageRank -* BetweennessCentrality -* ClosenessCentrality -* DegreeCentrality + - PageRank + - BetweennessCentrality + - ClosenessCentrality + - DegreeCentrality -###### Community Algorithm: +#### Community Algorithm: -* ClusteringCoefficient -* Kcore -* Lpa -* TriangleCount -* Wcc + - ClusteringCoefficient + - Kcore + - Lpa + - TriangleCount + - Wcc -###### Path Algorithm: +#### Path Algorithm: -* RingsDetection -* RingsDetectionWithFilter + - RingsDetection + - RingsDetectionWithFilter🧰 Tools
🪛 LanguageTool
[typographical] ~227-~227: Consider adding a comma here.
Context: ...ingsDetectionWithFilter More algorithms please see: [Built-In algorithms](https://gith...(PLEASE_COMMA)
content/cn/docs/quickstart/computing/hugegraph-computer.md (5)
9-9: 改进格式与措辞
建议在 “Kubernetes(K8s)/Yarn” 与括号之间添加空格，并将 “相对最大的区别之一” 替换为更准确的 “最显著的差异之一”：-[`HugeGraph-Computer`](https://github.com/apache/incubator-hugegraph-computer) 是分布式图处理系统 (OLAP). 它是 Pregel 的一个实现. 它可以运行在 Kubernetes(K8s)/Yarn 上。(它侧重可支持百亿~千亿的图数据量进行图计算, 会使用磁盘进行排序和加速, 这是它和 Vermeer 相对最大的区别之一) +[`HugeGraph-Computer`](https://github.com/apache/incubator-hugegraph-computer) 是分布式图处理系统 (OLAP)。它是 Pregel 的一个实现。它可以运行在 Kubernetes (K8s)/Yarn 上。(它侧重可支持百亿~千亿的图数据量进行图计算，会使用磁盘进行排序和加速，这是它和 Vermeer 最显著的差异之一)
85-85: 优化引用格式
将 “更多参考：modify-graphs-read-mode” 前添加 “详情请参阅”，并统一使用中文冒号：-如果没有启用 OLAP 索引，则需要启用，更多参考：[modify-graphs-read-mode] +如果没有启用 OLAP 索引，则需要启用。详情请参阅：[modify-graphs-read-mode]
140-140: 术语本地化建议
“computer crd spec” 建议翻译为 “Computer CRD 规范” 以与中文文档风格保持一致：-> 更多 computer crd spec 请看： +> 更多 Computer CRD 规范，请参阅：
142-142: 术语本地化建议
“Computer 配置请看” 建议改为 “Computer 配置，请参阅” 以提升阅读体验：-> 更多 Computer 配置请看： +> 更多 Computer 配置，请参阅：
209-212: 统一项目符号样式
将算法列表中的*改为-，与文档其他部分的项目符号保持一致：-* PageRank -* BetweennessCentrality -* ClosenessCentrality -* DegreeCentrality + - PageRank + - BetweennessCentrality + - ClosenessCentrality + - DegreeCentrality -* ClusteringCoefficient -* Kcore -* Lpa -* TriangleCount -* Wcc + - ClusteringCoefficient + - Kcore + - Lpa + - TriangleCount + - Wcc -* RingsDetection -* RingsDetectionWithFilter + - RingsDetection + - RingsDetectionWithFilterAlso applies to: 216-220, 224-225
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
209-209: Unordered list style
Expected: dash; Actual: asterisk(MD004, ul-style)
210-210: Unordered list style
Expected: dash; Actual: asterisk(MD004, ul-style)
211-211: Unordered list style
Expected: dash; Actual: asterisk(MD004, ul-style)
212-212: Unordered list style
Expected: dash; Actual: asterisk(MD004, ul-style)
content/en/docs/quickstart/hugegraph-ai/_index.md (1)
7-7: 建议优化提示语法当前句子“The official website regularly is updated…”语序略显不自然，建议改为：
> Please refer to the AI repository [README](…) for the most up-to-date documentation, and note that the official website is regularly updated and synchronized.content/en/docs/quickstart/hugegraph-ai/quick_start.md (3)
7-7: 优化引用主文档的表达建议将句子“Follow up [main doc] to introduce…”改为更自然的表述，例如：
> Refer to the [main documentation](../) for basic UI functions and details. Contributions are welcome at any time.🧰 Tools
🪛 LanguageTool
[uncategorized] ~7-~7: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...ain doc](../) to introduce the basic UI function & details, welcome to update and improv...(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
66-66: 调整句子前置词当前“Start the HugeGraph database, you can run it via Docker”语义有些伸展，建议分成两句：
1. Start the HugeGraph database. You can run it via Docker: ```bash docker run -itd --name=server -p 8080:8080 hugegraph/hugegraph--- `134-135`: **统一术语表达** 建议将“Graph extract head”改为“Graph extraction header”以保持专业术语一致性： ```diff - Graph extract head: The user-defined prompt of graph extracting + Graph extraction header: The user-defined prompt for graph extraction🧰 Tools
🪛 LanguageTool
[uncategorized] ~134-~134: Possible missing comma found.
Context: ...nterface, using the matched vertices as entities to convert the question into a Grem...(AI_HYDRA_LEO_MISSING_COMMA)
content/cn/docs/quickstart/hugegraph-ai/quick_start.md (1)
7-7: 优化提示语句建议将“请参考主文档了解基本 UI 功能及详细信息，欢迎随时更新和改进，谢谢”拆分或重组为更简洁的两句，例如：
> 请参考[主文档](../)获取基本 UI 功能与详细信息。 > 欢迎随时提出更新与改进！content/cn/docs/quickstart/hugegraph-ai/_index.md (4)
7-7: 删除多余符号并优化语句末尾多余的波浪线
~需要移除，建议改为：> 请参考 AI 仓库的 [README](…) 获取最新文档，官网会**定期**更新和同步。
11-11: 统一编号格式建议在“1 HugeGraph-AI 概述”后添加句点，保持与其他章节一致：
### 1. HugeGraph-AI 概述
68-72: 提供uv安装替代方案
curl安装脚本可能在部分环境不可用，建议补充pipx/pip install uv的可选命令：# 若无法使用 curl，可尝试 pip install uv # 或 pipx install uv
146-146: 调整示例标题层级“##### 4.1.2 通过 LLM 在 HugeGraph 中构建知识图谱”使用了 5 级标题，建议改为 4 级
####以匹配前文：#### 4.1.2 通过 LLM 在 HugeGraph 中构建知识图谱
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (21)
content/cn/docs/quickstart/client/_index.md(1 hunks)content/cn/docs/quickstart/computing/_index.md(1 hunks)content/cn/docs/quickstart/computing/hugegraph-computer.md(7 hunks)content/cn/docs/quickstart/computing/hugegraph-vermeer.md(1 hunks)content/cn/docs/quickstart/hugegraph-ai/_index.md(4 hunks)content/cn/docs/quickstart/hugegraph-ai/quick_start.md(1 hunks)content/cn/docs/quickstart/hugegraph/_index.md(1 hunks)content/cn/docs/quickstart/hugegraph/hugegraph-hstore.md(2 hunks)content/cn/docs/quickstart/hugegraph/hugegraph-server.md(3 hunks)content/cn/docs/quickstart/toolchain/_index.md(1 hunks)content/cn/docs/quickstart/toolchain/hugegraph-loader.md(3 hunks)content/en/docs/quickstart/client/_index.md(1 hunks)content/en/docs/quickstart/computing/_index.md(1 hunks)content/en/docs/quickstart/computing/hugegraph-computer.md(6 hunks)content/en/docs/quickstart/computing/hugegraph-vermeer.md(1 hunks)content/en/docs/quickstart/hugegraph-ai/_index.md(5 hunks)content/en/docs/quickstart/hugegraph-ai/quick_start.md(1 hunks)content/en/docs/quickstart/hugegraph/_index.md(1 hunks)content/en/docs/quickstart/hugegraph/hugegraph-hstore.md(1 hunks)content/en/docs/quickstart/hugegraph/hugegraph-server.md(12 hunks)content/en/docs/quickstart/toolchain/_index.md(1 hunks)
✅ Files skipped from review due to trivial changes (3)
- content/cn/docs/quickstart/computing/_index.md
- content/en/docs/quickstart/hugegraph/hugegraph-server.md
- content/cn/docs/quickstart/computing/hugegraph-vermeer.md
🚧 Files skipped from review as they are similar to previous changes (11)
- content/en/docs/quickstart/hugegraph/hugegraph-hstore.md
- content/cn/docs/quickstart/toolchain/_index.md
- content/en/docs/quickstart/client/_index.md
- content/cn/docs/quickstart/hugegraph/_index.md
- content/en/docs/quickstart/computing/hugegraph-vermeer.md
- content/cn/docs/quickstart/client/_index.md
- content/en/docs/quickstart/toolchain/_index.md
- content/en/docs/quickstart/computing/_index.md
- content/cn/docs/quickstart/toolchain/hugegraph-loader.md
- content/cn/docs/quickstart/hugegraph/hugegraph-hstore.md
- content/cn/docs/quickstart/hugegraph/hugegraph-server.md
🧰 Additional context used
🪛 LanguageTool
content/cn/docs/quickstart/hugegraph-ai/_index.md
[uncategorized] ~114-~114: 动词的修饰一般为‘形容词（副词）+地+动词’。您的意思是否是：最新"地"更改
Context: ...存到配置文件中。你也可以直接修改文件而无需重启应用程序；只需刷新页面即可加载最新的更改。 （可选）要重新生成配置文件，您可以将 `config.gener...
(wb4)
content/en/docs/quickstart/hugegraph-ai/_index.md
[uncategorized] ~66-~66: Possible missing preposition found.
Context: ...ost:8001 ### 3.2 Build from Source 1. Start the HugeGraph database, you can run it ...
(AI_HYDRA_LEO_MISSING_TO)
content/cn/docs/quickstart/hugegraph-ai/quick_start.md
[uncategorized] ~59-~59: 您的意思是“"不"和”？
Context: ...图数据 (1)：** 基于 Schema 从文档中提取图数据，使用图提取提示词头部和分块内容作为提示词 - 加载到图数据库 (2)： 将提取的图数据存储到...
(BU)
content/en/docs/quickstart/computing/hugegraph-computer.md
[style] ~9-~9: The word ‘biggest’ tends to be overused. Consider an alternative.
Context: ...g and acceleration, which is one of the biggest differences from Vermeer) ### Features - Support ...
(BIG_DIFFERENCE)
content/en/docs/quickstart/hugegraph-ai/quick_start.md
[uncategorized] ~7-~7: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...ain doc](../) to introduce the basic UI function & details, welcome to update and improv...
(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
[style] ~22-~22: ‘vid’ is informal. Consider replacing it.
Context: ...nowledge graph, chunk vector, and graph vid vector from the text. 
[style] ~57-~57: ‘Vid’ is informal. Consider replacing it.
Context: ...** Clear chunk vector - Clear Graph Vid Vector Index: Clear graph vid vector ...
(VID)
[style] ~57-~57: ‘vid’ is informal. Consider replacing it.
Context: ...r Graph Vid Vector Index**: Clear graph vid vector - Clear Graph Data: Clear ...
(VID)
[style] ~61-~61: ‘Vid’ is informal. Consider replacing it.
Context: ...he database (automatically calls Update Vid Embedding to store vectors in the vecto...
(VID)
[style] ~62-~62: ‘Vid’ is informal. Consider replacing it.
Context: ...tors in the vector database) - Update Vid Embedding: Convert graph vid into vec...
(VID)
[style] ~62-~62: ‘vid’ is informal. Consider replacing it.
Context: ...Update Vid Embedding: Convert graph vid into vectors ### Execution Flow: 1. I...
(VID)
[style] ~70-~70: ‘Vid’ is informal. Consider replacing it.
Context: ...base (this automatically calls Update Vid Embedding to store the vectors in the...
(VID)
[style] ~71-~71: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...the vectors in the vector database). 6. Click the Update Vid Embedding bu...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~71-~71: ‘Vid’ is informal. Consider replacing it.
Context: ...or database). 6. Click the Update Vid Embedding button to vectorize the...
(VID)
[style] ~75-~75: ‘Vid’ is informal. Consider replacing it.
Context: ...(chunks) into vectors, and the Update Vid Embedding button converts graph vid i...
(VID)
[style] ~75-~75: ‘vid’ is informal. Consider replacing it.
Context: ...e Vid Embedding** button converts graph vid into vectors. These vectors are stored ...
(VID)
[duplication] ~105-~105: Possible typo: you repeated a word.
Context: ...nput Fields: - Question: Input the query - Query Prompt: The prompt template used ...
(ENGLISH_WORD_REPEAT_RULE)
[style] ~114-~114: ‘vid’ is informal. Consider replacing it.
Context: ...ly graph-based retrieval (queries graph vid vectors in the vector database and the ...
(VID)
[style] ~132-~132: ‘vid’ is informal. Consider replacing it.
Context: ...zzy match in the vector database (graph vid vector) to retrieve relevant vertices. ...
(VID)
[uncategorized] ~134-~134: Possible missing comma found.
Context: ...nterface, using the matched vertices as entities to convert the question into a Grem...
(AI_HYDRA_LEO_MISSING_COMMA)
🪛 markdownlint-cli2 (0.17.2)
content/cn/docs/quickstart/computing/hugegraph-computer.md
207-207: Heading levels should only increment by one level at a time
Expected: h4; Actual: h6
(MD001, heading-increment)
209-209: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
210-210: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
211-211: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
212-212: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
216-216: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
217-217: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
218-218: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
219-219: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
220-220: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
224-224: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
225-225: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
content/en/docs/quickstart/hugegraph-ai/quick_start.md
11-11: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
16-16: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
40-40: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3
(MD001, heading-increment)
40-40: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
47-47: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
64-64: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
103-103: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3
(MD001, heading-increment)
103-103: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
110-110: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
119-119: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
182-182: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3
(MD001, heading-increment)
182-182: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
190-190: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
208-208: Code block style
Expected: fenced; Actual: indented
(MD046, code-block-style)
🔇 Additional comments (19)
content/en/docs/quickstart/hugegraph/_index.md (2)
1-5: Frontmatter 格式正确
YAML 头部语法无误，title、linkTitle 和 weight 字段齐全且符合项目文档结构规范。
4-4:Details
✅ Verification successful
验证 weight 排序
请检查content/en/docs/quickstart/下其他组件的_index.md文件中 weight 值是否唯一且按预期排列，确保侧边导航顺序正确。
🏁 Script executed:
#!/bin/bash # 列出所有 quickstart 目录下的 weight 字段及其所在文件 rg '^weight:' -n content/en/docs/quickstart/*/_index.mdLength of output: 548
验证 Quickstart 侧边栏导航权重排序
已在
content/en/docs/quickstart/*/_index.md中确认各 weight 值：
- hugegraph/_index.md：1
- toolchain/_index.md：2
- hugegraph-ai/_index.md：3
- computing/_index.md：4
- client/_index.md：5
所有 weight 值唯一且按 1–5 排列，侧边导航顺序符合预期，无需调整。
content/en/docs/quickstart/computing/hugegraph-computer.md (3)
4-4: 权重调整确认
将weight从 6 修改为 2 以调整在导航中的优先级，符合文档结构优化需求。
33-33: 确认运行前置条件说明
新增提示 “To run the algorithm ... you need to install Java 11 or later versions.”，清晰传达依赖需求，内容准确。
101-101: 确认 Kubernetes 前提提示
新增 “you need to deploy HugeGraph-Server first” 提示，避免用户遗漏部署顺序，内容恰当。content/cn/docs/quickstart/computing/hugegraph-computer.md (5)
4-4: 权重调整确认
将weight从 6 修改为 2 以优化导航顺序，与英文版保持一致。
14-14: 功能点翻译确认
新增 “算法基于 BSP 模型...每一次迭代都是一次超步” 描述，条理清晰，内容准确。
59-59: 命令说明简化
“编译生成 tar 包” 描述清晰，与英文版对应，无需修改。
68-69: 配置文件说明确认
新增提示参数-c用于指定配置文件，符合使用习惯，表述准确。
205-205: 算法列表标题确认
“### 4.1 支持的算法列表” 与英文版保持一致，无需调整。content/en/docs/quickstart/hugegraph-ai/_index.md (3)
2-2: 确认文档标题更新文档标题从旧的“HugeGraph-AI Quick Start”更新为“Explore with HugeGraph-AI”，与新增内容契合。
4-4: 调整文档排序权重已将权重更新为
3，确保导航顺序符合预期。
9-9: 添加 DeepWiki 徽章展示引入 DeepWiki 徽章以便快速访问 AI 文档汇总，增强文档可读性。
content/en/docs/quickstart/hugegraph-ai/quick_start.md (3)
1-5: 确认文档元信息更新前言部分的 frontmatter 已正确添加，包括标题、linkTitle 和权重，符合文档规范。
152-152: 使用get_chat_llm()的示例已正确更新为
LLMs().get_chat_llm()以匹配新的初始化接口。
216-217: 修正参数名称已将
max_items更新为max_graph_items，与实际接口保持一致。content/cn/docs/quickstart/hugegraph-ai/quick_start.md (1)
1-4: 确认文档元信息已正确添加 frontmatter，包括 title、linkTitle 和 weight，符合文档结构要求。
content/cn/docs/quickstart/hugegraph-ai/_index.md (2)
2-4: 确认文档元信息更新已正确修改 title、linkTitle 和 weight，符合文档目录规范。
108-111: 中英文文档不一致中文索引中包含 Text2Gremlin 演示的启动步骤，而英文索引未提及此部分，请核对并保持两版文档一致。
Likely an incorrect or invalid review comment.
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (5)
content/cn/docs/clients/hugegraph-client.md (3)
19-19: 命名一致性：建议统一为HugeGraph-Server
注释中写作HugeGraphServer，建议加上连字符，并与文档中其他地方的HugeGraph-Server保持一致。
27-29: 命名及语法：统一HugeGraph-Hubble的表现形式
第29行写作`HugeGraph - Hubble`，建议移除空格，统一为`HugeGraph-Hubble`。
360-366: 列表缩进不一致：请调整嵌套列表的缩进
Markdown 嵌套列表的缩进应保持一致（例如每级增加 2 或 4 个空格），当前缩进混乱会导致渲染异常。🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
360-360: Unordered list indentation
Expected: 4; Actual: 8(MD007, ul-indent)
362-362: Unordered list indentation
Expected: 4; Actual: 8(MD007, ul-indent)
content/en/docs/language/hugegraph-example.md (2)
7-7: 标题编号样式一致性
建议在章节标题后添加句点以保持编号一致，例如将### 1 Overview改为
### 1. Overview
121-121: 移除多余空格以优化示例代码
在示例代码g.V().hasLabel('character') .has('name','hercules')中建议删除方法链之间的空格，以符合常见写法：
-g.V().hasLabel('character') .has('name','hercules') +g.V().hasLabel('character').has('name','hercules')
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
content/cn/docs/clients/hugegraph-client.md(14 hunks)content/cn/docs/language/hugegraph-example.md(6 hunks)content/cn/docs/quickstart/client/hugegraph-client.md(2 hunks)content/en/docs/language/hugegraph-example.md(4 hunks)
✅ Files skipped from review due to trivial changes (2)
- content/cn/docs/quickstart/client/hugegraph-client.md
- content/cn/docs/language/hugegraph-example.md
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
content/cn/docs/clients/hugegraph-client.md
360-360: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
362-362: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
367-367: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
368-368: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
371-371: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
372-372: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
375-375: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
376-376: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
379-379: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
380-380: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
🪛 LanguageTool
content/en/docs/language/hugegraph-example.md
[style] ~13-~13: Consider using a different adverb to strengthen your wording.
Context: ...e and interfaces. However, HugeGraph is a completely new design and development, characteriz...
(COMPLETELY_ENTIRELY)
[grammar] ~52-~52: Possible agreement error. The noun ‘source’ seems to be countable; consider using: “pair of sources”.
Context: ...ph, each edge label can only act on one pair of source and target vertex labels. In other word...
(A_COLLECTIVE_OF_NN)
🔇 Additional comments (21)
content/cn/docs/clients/hugegraph-client.md (9)
9-10: 格式校对：中英文混合空格增加
已在中英文、标点后的空格进行了补充，阅读体验更佳。
35-37: 描述完善：SchemaManager 说明
对 SchemaManager 的功能与获取方式描述清晰，格式优化合理。
43-43: 示例改进：HugeGraph-Hubble环境说明
Gremlin 示例部分已替换为HugeGraph-Hubble，保持与整体重构一致。
100-100: 示例改进：PropertyKey Groovy 语法
在HugeGraph-Hubble中给出了groovy示例，内容准确且符合新结构。
119-122: 示例完善：查询 PropertyKey
增加了注释以说明获取 PropertyKey 及其属性的方法，示例准确。
135-135: 描述完善：VertexLabel 约束说明
VertexLabel 约束信息说明已补充，内容完整且逻辑清晰。
180-180: 描述优化：enableLabelIndex 参数说明
已补充 Label 索引开关的说明，帮助用户理解性能影响。
262-262: 描述完善：frequency 说明
对 frequency 参数的含义及配置提供了清晰介绍。
315-318: 示例完善：查询 EdgeLabel
增加了获取 EdgeLabel 对象及属性的方法注释，示例准确。content/en/docs/language/hugegraph-example.md (12)
9-9: 翻译准确，内容清晰。
该句用词和语法都很到位，无需修改。
11-11: 小节标题格式良好
该标题表达清晰，与文档风格保持一致。
19-19: 描述准确，内容无误
该要点表述清晰，与原文一致。
21-21: 描述准确，内容无误
该要点表述清晰，与原文一致。
23-23: 描述准确，内容无误
该要点表述清晰，与原文一致。
33-33: 图例说明清晰
该段对图中元素的说明准确，可保持现状。
37-42: 顶点表格格式与内容良好
表格对齐正确，术语使用一致，无需修改。
44-44: 关系类型列表清晰
该列表覆盖所有关系类型，描述准确。
46-52: 关系表格格式与内容良好
表头及列对齐正确，属性列与原文一致，无需修改。🧰 Tools
🪛 LanguageTool
[grammar] ~52-~52: Possible agreement error. The noun ‘source’ seems to be countable; consider using: “pair of sources”.
Context: ...ph, each edge label can only act on one pair of source and target vertex labels. In other word...(A_COLLECTIVE_OF_NN)
53-53: 语句通顺，内容准确
该段落描述清晰，已使用 “In other words” 等正确表达，无需调整。
133-133: 示例补充清晰
对repeat方法的示例介绍清晰，可保持现状。
139-139: 小标题格式一致
该行标题译文准确，与文档风格统一。
There was a problem hiding this comment.
Actionable comments posted: 2
♻️ Duplicate comments (2)
content/en/docs/language/hugegraph-example.md (2)
17-17: 更新工具列表名称请将文中
HugeGraph-Studio替换为HugeGraph-Hubble，并同步更新对应的链接。
181-181:⚠️ Potential issue修正链接路径和工具名称
当前链接路径
/docs/...应改为/en/docs/...，且工具名称HugeGraph-Api拼写不一致，需统一为HugeGraph-API。
请应用以下 diff：-It is recommended to use [HugeGraph-Hubble](/docs/quickstart/toolchain/hugegraph-hubble) to execute the above code visually. Additionally, the code can be executed through various other methods such as HugeGraph-Client, HugeGraph-Api, GremlinConsole, and GremlinDriver. +It is recommended to use [HugeGraph-Hubble](/en/docs/quickstart/toolchain/hugegraph-hubble) to execute the above code visually. Additionally, the code can be executed through various other methods such as HugeGraph-Client, HugeGraph-API, GremlinConsole, and GremlinDriver.
🧹 Nitpick comments (9)
content/cn/docs/quickstart/client/hugegraph-client-go.md (2)
9-12: 建议补充“软件架构”部分的实际内容
当前第9–12行存在占位符“(软件架构说明)”，请替换为实质性的架构描述，以免用户困惑。
1-164: 统一使用空格替代制表符
文档中大量使用硬制表符（tab）导致 markdownlint 报 MD010 报错，建议全局将制表符替换为空格缩进，以提升可读性和格式一致性。🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
34-34: Hard tabs
Column: 1(MD010, no-hard-tabs)
35-35: Hard tabs
Column: 1(MD010, no-hard-tabs)
37-37: Hard tabs
Column: 1(MD010, no-hard-tabs)
38-38: Hard tabs
Column: 1(MD010, no-hard-tabs)
42-42: Hard tabs
Column: 1(MD010, no-hard-tabs)
43-43: Hard tabs
Column: 1(MD010, no-hard-tabs)
44-44: Hard tabs
Column: 1(MD010, no-hard-tabs)
45-45: Hard tabs
Column: 1(MD010, no-hard-tabs)
46-46: Hard tabs
Column: 1(MD010, no-hard-tabs)
47-47: Hard tabs
Column: 1(MD010, no-hard-tabs)
48-48: Hard tabs
Column: 1(MD010, no-hard-tabs)
49-49: Hard tabs
Column: 1(MD010, no-hard-tabs)
50-50: Hard tabs
Column: 1(MD010, no-hard-tabs)
51-51: Hard tabs
Column: 1(MD010, no-hard-tabs)
52-52: Hard tabs
Column: 1(MD010, no-hard-tabs)
53-53: Hard tabs
Column: 1(MD010, no-hard-tabs)
55-55: Hard tabs
Column: 1(MD010, no-hard-tabs)
56-56: Hard tabs
Column: 1(MD010, no-hard-tabs)
57-57: Hard tabs
Column: 1(MD010, no-hard-tabs)
59-59: Hard tabs
Column: 1(MD010, no-hard-tabs)
60-60: Hard tabs
Column: 1(MD010, no-hard-tabs)
72-72: Hard tabs
Column: 1(MD010, no-hard-tabs)
73-73: Hard tabs
Column: 1(MD010, no-hard-tabs)
74-74: Hard tabs
Column: 1(MD010, no-hard-tabs)
76-76: Hard tabs
Column: 1(MD010, no-hard-tabs)
77-77: Hard tabs
Column: 1(MD010, no-hard-tabs)
82-82: Hard tabs
Column: 1(MD010, no-hard-tabs)
83-83: Hard tabs
Column: 1(MD010, no-hard-tabs)
84-84: Hard tabs
Column: 1(MD010, no-hard-tabs)
85-85: Hard tabs
Column: 1(MD010, no-hard-tabs)
86-86: Hard tabs
Column: 1(MD010, no-hard-tabs)
87-87: Hard tabs
Column: 1(MD010, no-hard-tabs)
88-88: Hard tabs
Column: 1(MD010, no-hard-tabs)
89-89: Hard tabs
Column: 1(MD010, no-hard-tabs)
90-90: Hard tabs
Column: 1(MD010, no-hard-tabs)
91-91: Hard tabs
Column: 1(MD010, no-hard-tabs)
92-92: Hard tabs
Column: 1(MD010, no-hard-tabs)
93-93: Hard tabs
Column: 1(MD010, no-hard-tabs)
94-94: Hard tabs
Column: 1(MD010, no-hard-tabs)
95-95: Hard tabs
Column: 1(MD010, no-hard-tabs)
96-96: Hard tabs
Column: 1(MD010, no-hard-tabs)
97-97: Hard tabs
Column: 1(MD010, no-hard-tabs)
101-101: Hard tabs
Column: 1(MD010, no-hard-tabs)
102-102: Hard tabs
Column: 1(MD010, no-hard-tabs)
103-103: Hard tabs
Column: 1(MD010, no-hard-tabs)
104-104: Hard tabs
Column: 1(MD010, no-hard-tabs)
105-105: Hard tabs
Column: 1(MD010, no-hard-tabs)
106-106: Hard tabs
Column: 1(MD010, no-hard-tabs)
107-107: Hard tabs
Column: 1(MD010, no-hard-tabs)
108-108: Hard tabs
Column: 1(MD010, no-hard-tabs)
109-109: Hard tabs
Column: 1(MD010, no-hard-tabs)
110-110: Hard tabs
Column: 1(MD010, no-hard-tabs)
111-111: Hard tabs
Column: 1(MD010, no-hard-tabs)
112-112: Hard tabs
Column: 1(MD010, no-hard-tabs)
113-113: Hard tabs
Column: 1(MD010, no-hard-tabs)
115-115: Hard tabs
Column: 1(MD010, no-hard-tabs)
116-116: Hard tabs
Column: 1(MD010, no-hard-tabs)
117-117: Hard tabs
Column: 1(MD010, no-hard-tabs)
118-118: Hard tabs
Column: 1(MD010, no-hard-tabs)
119-119: Hard tabs
Column: 1(MD010, no-hard-tabs)
120-120: Hard tabs
Column: 1(MD010, no-hard-tabs)
121-121: Hard tabs
Column: 1(MD010, no-hard-tabs)
122-122: Hard tabs
Column: 1(MD010, no-hard-tabs)
123-123: Hard tabs
Column: 1(MD010, no-hard-tabs)
124-124: Hard tabs
Column: 1(MD010, no-hard-tabs)
125-125: Hard tabs
Column: 1(MD010, no-hard-tabs)
126-126: Hard tabs
Column: 1(MD010, no-hard-tabs)
127-127: Hard tabs
Column: 1(MD010, no-hard-tabs)
128-128: Hard tabs
Column: 1(MD010, no-hard-tabs)
129-129: Hard tabs
Column: 1(MD010, no-hard-tabs)
131-131: Hard tabs
Column: 1(MD010, no-hard-tabs)
132-132: Hard tabs
Column: 1(MD010, no-hard-tabs)
132-132: Hard tabs
Column: 5(MD010, no-hard-tabs)
133-133: Hard tabs
Column: 1(MD010, no-hard-tabs)
134-134: Hard tabs
Column: 1(MD010, no-hard-tabs)
136-136: Hard tabs
Column: 1(MD010, no-hard-tabs)
137-137: Hard tabs
Column: 1(MD010, no-hard-tabs)
141-141: Hard tabs
Column: 1(MD010, no-hard-tabs)
152-152: Hard tabs
Column: 1(MD010, no-hard-tabs)
153-153: Hard tabs
Column: 1(MD010, no-hard-tabs)
154-154: Hard tabs
Column: 1(MD010, no-hard-tabs)
155-155: Hard tabs
Column: 1(MD010, no-hard-tabs)
156-156: Hard tabs
Column: 1(MD010, no-hard-tabs)
157-157: Hard tabs
Column: 1(MD010, no-hard-tabs)
content/en/docs/quickstart/client/hugegraph-client-go.md (2)
9-12: 建议补充“Software Architecture”部分的实际内容
当前第9–12行仍为占位符“(Software architecture description)”，请补充完整的架构说明，以便读者理解 SDK 设计要点。
1-164: 统一使用空格替代制表符
整页文档中多处使用硬制表符，markdownlint 已报 MD010。建议将制表符改为空格缩进，确保跨编辑器一致。🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
34-34: Hard tabs
Column: 1(MD010, no-hard-tabs)
35-35: Hard tabs
Column: 1(MD010, no-hard-tabs)
37-37: Hard tabs
Column: 1(MD010, no-hard-tabs)
38-38: Hard tabs
Column: 1(MD010, no-hard-tabs)
42-42: Hard tabs
Column: 1(MD010, no-hard-tabs)
43-43: Hard tabs
Column: 1(MD010, no-hard-tabs)
44-44: Hard tabs
Column: 1(MD010, no-hard-tabs)
45-45: Hard tabs
Column: 1(MD010, no-hard-tabs)
46-46: Hard tabs
Column: 1(MD010, no-hard-tabs)
47-47: Hard tabs
Column: 1(MD010, no-hard-tabs)
48-48: Hard tabs
Column: 1(MD010, no-hard-tabs)
49-49: Hard tabs
Column: 1(MD010, no-hard-tabs)
50-50: Hard tabs
Column: 1(MD010, no-hard-tabs)
51-51: Hard tabs
Column: 1(MD010, no-hard-tabs)
52-52: Hard tabs
Column: 1(MD010, no-hard-tabs)
53-53: Hard tabs
Column: 1(MD010, no-hard-tabs)
55-55: Hard tabs
Column: 1(MD010, no-hard-tabs)
56-56: Hard tabs
Column: 1(MD010, no-hard-tabs)
57-57: Hard tabs
Column: 1(MD010, no-hard-tabs)
59-59: Hard tabs
Column: 1(MD010, no-hard-tabs)
60-60: Hard tabs
Column: 1(MD010, no-hard-tabs)
72-72: Hard tabs
Column: 1(MD010, no-hard-tabs)
73-73: Hard tabs
Column: 1(MD010, no-hard-tabs)
74-74: Hard tabs
Column: 1(MD010, no-hard-tabs)
76-76: Hard tabs
Column: 1(MD010, no-hard-tabs)
77-77: Hard tabs
Column: 1(MD010, no-hard-tabs)
82-82: Hard tabs
Column: 1(MD010, no-hard-tabs)
83-83: Hard tabs
Column: 1(MD010, no-hard-tabs)
84-84: Hard tabs
Column: 1(MD010, no-hard-tabs)
85-85: Hard tabs
Column: 1(MD010, no-hard-tabs)
86-86: Hard tabs
Column: 1(MD010, no-hard-tabs)
87-87: Hard tabs
Column: 1(MD010, no-hard-tabs)
88-88: Hard tabs
Column: 1(MD010, no-hard-tabs)
89-89: Hard tabs
Column: 1(MD010, no-hard-tabs)
90-90: Hard tabs
Column: 1(MD010, no-hard-tabs)
91-91: Hard tabs
Column: 1(MD010, no-hard-tabs)
92-92: Hard tabs
Column: 1(MD010, no-hard-tabs)
93-93: Hard tabs
Column: 1(MD010, no-hard-tabs)
94-94: Hard tabs
Column: 1(MD010, no-hard-tabs)
95-95: Hard tabs
Column: 1(MD010, no-hard-tabs)
96-96: Hard tabs
Column: 1(MD010, no-hard-tabs)
97-97: Hard tabs
Column: 1(MD010, no-hard-tabs)
101-101: Hard tabs
Column: 1(MD010, no-hard-tabs)
102-102: Hard tabs
Column: 1(MD010, no-hard-tabs)
103-103: Hard tabs
Column: 1(MD010, no-hard-tabs)
104-104: Hard tabs
Column: 1(MD010, no-hard-tabs)
105-105: Hard tabs
Column: 1(MD010, no-hard-tabs)
106-106: Hard tabs
Column: 1(MD010, no-hard-tabs)
107-107: Hard tabs
Column: 1(MD010, no-hard-tabs)
108-108: Hard tabs
Column: 1(MD010, no-hard-tabs)
109-109: Hard tabs
Column: 1(MD010, no-hard-tabs)
110-110: Hard tabs
Column: 1(MD010, no-hard-tabs)
111-111: Hard tabs
Column: 1(MD010, no-hard-tabs)
112-112: Hard tabs
Column: 1(MD010, no-hard-tabs)
113-113: Hard tabs
Column: 1(MD010, no-hard-tabs)
115-115: Hard tabs
Column: 1(MD010, no-hard-tabs)
116-116: Hard tabs
Column: 1(MD010, no-hard-tabs)
117-117: Hard tabs
Column: 1(MD010, no-hard-tabs)
118-118: Hard tabs
Column: 1(MD010, no-hard-tabs)
119-119: Hard tabs
Column: 1(MD010, no-hard-tabs)
120-120: Hard tabs
Column: 1(MD010, no-hard-tabs)
121-121: Hard tabs
Column: 1(MD010, no-hard-tabs)
122-122: Hard tabs
Column: 1(MD010, no-hard-tabs)
123-123: Hard tabs
Column: 1(MD010, no-hard-tabs)
124-124: Hard tabs
Column: 1(MD010, no-hard-tabs)
125-125: Hard tabs
Column: 1(MD010, no-hard-tabs)
126-126: Hard tabs
Column: 1(MD010, no-hard-tabs)
127-127: Hard tabs
Column: 1(MD010, no-hard-tabs)
128-128: Hard tabs
Column: 1(MD010, no-hard-tabs)
129-129: Hard tabs
Column: 1(MD010, no-hard-tabs)
131-131: Hard tabs
Column: 1(MD010, no-hard-tabs)
132-132: Hard tabs
Column: 1(MD010, no-hard-tabs)
132-132: Hard tabs
Column: 5(MD010, no-hard-tabs)
133-133: Hard tabs
Column: 1(MD010, no-hard-tabs)
134-134: Hard tabs
Column: 1(MD010, no-hard-tabs)
136-136: Hard tabs
Column: 1(MD010, no-hard-tabs)
137-137: Hard tabs
Column: 1(MD010, no-hard-tabs)
141-141: Hard tabs
Column: 1(MD010, no-hard-tabs)
152-152: Hard tabs
Column: 1(MD010, no-hard-tabs)
153-153: Hard tabs
Column: 1(MD010, no-hard-tabs)
154-154: Hard tabs
Column: 1(MD010, no-hard-tabs)
155-155: Hard tabs
Column: 1(MD010, no-hard-tabs)
156-156: Hard tabs
Column: 1(MD010, no-hard-tabs)
157-157: Hard tabs
Column: 1(MD010, no-hard-tabs)
content/en/docs/quickstart/client/hugegraph-client-python.md (1)
1-190: 统一使用空格替代制表符
文档多处使用硬制表符，markdownlint 已报 MD010。请将所有制表符替换为空格，以提升可维护性。content/cn/docs/quickstart/client/hugegraph-client-python.md (1)
1-189: 统一使用空格替代制表符
文档中广泛使用硬制表符，导致 markdownlint 报 MD010。建议替换为空格缩进，以统一格式并避免 lint 报错。content/en/docs/language/hugegraph-example.md (3)
7-7: 建议移除标题数字当前标题使用了
### 1 Overview格式，为提高可读性并与其他文档保持一致，建议将数字前缀去掉，仅保留### Overview。
9-9: 使用 HTTPS 强化链接安全此处链接使用了
http://s3.thinkaurelius.com/...，建议改为https://s3.thinkaurelius.com/...以提升安全性。
133-133: 建议优化表述建议将
It can also be done using the \repeat` method:改为Alternatively, you can use the `repeat` method:`，以提升衔接和可读性。
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (5)
content/cn/docs/quickstart/client/hugegraph-client-go.md(1 hunks)content/cn/docs/quickstart/client/hugegraph-client-python.md(1 hunks)content/en/docs/language/hugegraph-example.md(4 hunks)content/en/docs/quickstart/client/hugegraph-client-go.md(1 hunks)content/en/docs/quickstart/client/hugegraph-client-python.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
content/cn/docs/quickstart/client/hugegraph-client-go.md
34-34: Hard tabs
Column: 1
(MD010, no-hard-tabs)
35-35: Hard tabs
Column: 1
(MD010, no-hard-tabs)
37-37: Hard tabs
Column: 1
(MD010, no-hard-tabs)
38-38: Hard tabs
Column: 1
(MD010, no-hard-tabs)
42-42: Hard tabs
Column: 1
(MD010, no-hard-tabs)
43-43: Hard tabs
Column: 1
(MD010, no-hard-tabs)
44-44: Hard tabs
Column: 1
(MD010, no-hard-tabs)
45-45: Hard tabs
Column: 1
(MD010, no-hard-tabs)
46-46: Hard tabs
Column: 1
(MD010, no-hard-tabs)
47-47: Hard tabs
Column: 1
(MD010, no-hard-tabs)
48-48: Hard tabs
Column: 1
(MD010, no-hard-tabs)
49-49: Hard tabs
Column: 1
(MD010, no-hard-tabs)
50-50: Hard tabs
Column: 1
(MD010, no-hard-tabs)
51-51: Hard tabs
Column: 1
(MD010, no-hard-tabs)
52-52: Hard tabs
Column: 1
(MD010, no-hard-tabs)
53-53: Hard tabs
Column: 1
(MD010, no-hard-tabs)
55-55: Hard tabs
Column: 1
(MD010, no-hard-tabs)
56-56: Hard tabs
Column: 1
(MD010, no-hard-tabs)
57-57: Hard tabs
Column: 1
(MD010, no-hard-tabs)
59-59: Hard tabs
Column: 1
(MD010, no-hard-tabs)
60-60: Hard tabs
Column: 1
(MD010, no-hard-tabs)
72-72: Hard tabs
Column: 1
(MD010, no-hard-tabs)
73-73: Hard tabs
Column: 1
(MD010, no-hard-tabs)
74-74: Hard tabs
Column: 1
(MD010, no-hard-tabs)
76-76: Hard tabs
Column: 1
(MD010, no-hard-tabs)
77-77: Hard tabs
Column: 1
(MD010, no-hard-tabs)
82-82: Hard tabs
Column: 1
(MD010, no-hard-tabs)
83-83: Hard tabs
Column: 1
(MD010, no-hard-tabs)
84-84: Hard tabs
Column: 1
(MD010, no-hard-tabs)
85-85: Hard tabs
Column: 1
(MD010, no-hard-tabs)
86-86: Hard tabs
Column: 1
(MD010, no-hard-tabs)
87-87: Hard tabs
Column: 1
(MD010, no-hard-tabs)
88-88: Hard tabs
Column: 1
(MD010, no-hard-tabs)
89-89: Hard tabs
Column: 1
(MD010, no-hard-tabs)
90-90: Hard tabs
Column: 1
(MD010, no-hard-tabs)
91-91: Hard tabs
Column: 1
(MD010, no-hard-tabs)
92-92: Hard tabs
Column: 1
(MD010, no-hard-tabs)
93-93: Hard tabs
Column: 1
(MD010, no-hard-tabs)
94-94: Hard tabs
Column: 1
(MD010, no-hard-tabs)
95-95: Hard tabs
Column: 1
(MD010, no-hard-tabs)
96-96: Hard tabs
Column: 1
(MD010, no-hard-tabs)
97-97: Hard tabs
Column: 1
(MD010, no-hard-tabs)
101-101: Hard tabs
Column: 1
(MD010, no-hard-tabs)
102-102: Hard tabs
Column: 1
(MD010, no-hard-tabs)
103-103: Hard tabs
Column: 1
(MD010, no-hard-tabs)
104-104: Hard tabs
Column: 1
(MD010, no-hard-tabs)
105-105: Hard tabs
Column: 1
(MD010, no-hard-tabs)
106-106: Hard tabs
Column: 1
(MD010, no-hard-tabs)
107-107: Hard tabs
Column: 1
(MD010, no-hard-tabs)
108-108: Hard tabs
Column: 1
(MD010, no-hard-tabs)
109-109: Hard tabs
Column: 1
(MD010, no-hard-tabs)
110-110: Hard tabs
Column: 1
(MD010, no-hard-tabs)
111-111: Hard tabs
Column: 1
(MD010, no-hard-tabs)
112-112: Hard tabs
Column: 1
(MD010, no-hard-tabs)
113-113: Hard tabs
Column: 1
(MD010, no-hard-tabs)
115-115: Hard tabs
Column: 1
(MD010, no-hard-tabs)
116-116: Hard tabs
Column: 1
(MD010, no-hard-tabs)
117-117: Hard tabs
Column: 1
(MD010, no-hard-tabs)
118-118: Hard tabs
Column: 1
(MD010, no-hard-tabs)
119-119: Hard tabs
Column: 1
(MD010, no-hard-tabs)
120-120: Hard tabs
Column: 1
(MD010, no-hard-tabs)
121-121: Hard tabs
Column: 1
(MD010, no-hard-tabs)
122-122: Hard tabs
Column: 1
(MD010, no-hard-tabs)
123-123: Hard tabs
Column: 1
(MD010, no-hard-tabs)
124-124: Hard tabs
Column: 1
(MD010, no-hard-tabs)
125-125: Hard tabs
Column: 1
(MD010, no-hard-tabs)
126-126: Hard tabs
Column: 1
(MD010, no-hard-tabs)
127-127: Hard tabs
Column: 1
(MD010, no-hard-tabs)
128-128: Hard tabs
Column: 1
(MD010, no-hard-tabs)
129-129: Hard tabs
Column: 1
(MD010, no-hard-tabs)
131-131: Hard tabs
Column: 1
(MD010, no-hard-tabs)
132-132: Hard tabs
Column: 1
(MD010, no-hard-tabs)
132-132: Hard tabs
Column: 5
(MD010, no-hard-tabs)
133-133: Hard tabs
Column: 1
(MD010, no-hard-tabs)
134-134: Hard tabs
Column: 1
(MD010, no-hard-tabs)
136-136: Hard tabs
Column: 1
(MD010, no-hard-tabs)
137-137: Hard tabs
Column: 1
(MD010, no-hard-tabs)
141-141: Hard tabs
Column: 1
(MD010, no-hard-tabs)
152-152: Hard tabs
Column: 1
(MD010, no-hard-tabs)
153-153: Hard tabs
Column: 1
(MD010, no-hard-tabs)
154-154: Hard tabs
Column: 1
(MD010, no-hard-tabs)
155-155: Hard tabs
Column: 1
(MD010, no-hard-tabs)
156-156: Hard tabs
Column: 1
(MD010, no-hard-tabs)
157-157: Hard tabs
Column: 1
(MD010, no-hard-tabs)
content/en/docs/quickstart/client/hugegraph-client-go.md
34-34: Hard tabs
Column: 1
(MD010, no-hard-tabs)
35-35: Hard tabs
Column: 1
(MD010, no-hard-tabs)
37-37: Hard tabs
Column: 1
(MD010, no-hard-tabs)
38-38: Hard tabs
Column: 1
(MD010, no-hard-tabs)
42-42: Hard tabs
Column: 1
(MD010, no-hard-tabs)
43-43: Hard tabs
Column: 1
(MD010, no-hard-tabs)
44-44: Hard tabs
Column: 1
(MD010, no-hard-tabs)
45-45: Hard tabs
Column: 1
(MD010, no-hard-tabs)
46-46: Hard tabs
Column: 1
(MD010, no-hard-tabs)
47-47: Hard tabs
Column: 1
(MD010, no-hard-tabs)
48-48: Hard tabs
Column: 1
(MD010, no-hard-tabs)
49-49: Hard tabs
Column: 1
(MD010, no-hard-tabs)
50-50: Hard tabs
Column: 1
(MD010, no-hard-tabs)
51-51: Hard tabs
Column: 1
(MD010, no-hard-tabs)
52-52: Hard tabs
Column: 1
(MD010, no-hard-tabs)
53-53: Hard tabs
Column: 1
(MD010, no-hard-tabs)
55-55: Hard tabs
Column: 1
(MD010, no-hard-tabs)
56-56: Hard tabs
Column: 1
(MD010, no-hard-tabs)
57-57: Hard tabs
Column: 1
(MD010, no-hard-tabs)
59-59: Hard tabs
Column: 1
(MD010, no-hard-tabs)
60-60: Hard tabs
Column: 1
(MD010, no-hard-tabs)
72-72: Hard tabs
Column: 1
(MD010, no-hard-tabs)
73-73: Hard tabs
Column: 1
(MD010, no-hard-tabs)
74-74: Hard tabs
Column: 1
(MD010, no-hard-tabs)
76-76: Hard tabs
Column: 1
(MD010, no-hard-tabs)
77-77: Hard tabs
Column: 1
(MD010, no-hard-tabs)
82-82: Hard tabs
Column: 1
(MD010, no-hard-tabs)
83-83: Hard tabs
Column: 1
(MD010, no-hard-tabs)
84-84: Hard tabs
Column: 1
(MD010, no-hard-tabs)
85-85: Hard tabs
Column: 1
(MD010, no-hard-tabs)
86-86: Hard tabs
Column: 1
(MD010, no-hard-tabs)
87-87: Hard tabs
Column: 1
(MD010, no-hard-tabs)
88-88: Hard tabs
Column: 1
(MD010, no-hard-tabs)
89-89: Hard tabs
Column: 1
(MD010, no-hard-tabs)
90-90: Hard tabs
Column: 1
(MD010, no-hard-tabs)
91-91: Hard tabs
Column: 1
(MD010, no-hard-tabs)
92-92: Hard tabs
Column: 1
(MD010, no-hard-tabs)
93-93: Hard tabs
Column: 1
(MD010, no-hard-tabs)
94-94: Hard tabs
Column: 1
(MD010, no-hard-tabs)
95-95: Hard tabs
Column: 1
(MD010, no-hard-tabs)
96-96: Hard tabs
Column: 1
(MD010, no-hard-tabs)
97-97: Hard tabs
Column: 1
(MD010, no-hard-tabs)
101-101: Hard tabs
Column: 1
(MD010, no-hard-tabs)
102-102: Hard tabs
Column: 1
(MD010, no-hard-tabs)
103-103: Hard tabs
Column: 1
(MD010, no-hard-tabs)
104-104: Hard tabs
Column: 1
(MD010, no-hard-tabs)
105-105: Hard tabs
Column: 1
(MD010, no-hard-tabs)
106-106: Hard tabs
Column: 1
(MD010, no-hard-tabs)
107-107: Hard tabs
Column: 1
(MD010, no-hard-tabs)
108-108: Hard tabs
Column: 1
(MD010, no-hard-tabs)
109-109: Hard tabs
Column: 1
(MD010, no-hard-tabs)
110-110: Hard tabs
Column: 1
(MD010, no-hard-tabs)
111-111: Hard tabs
Column: 1
(MD010, no-hard-tabs)
112-112: Hard tabs
Column: 1
(MD010, no-hard-tabs)
113-113: Hard tabs
Column: 1
(MD010, no-hard-tabs)
115-115: Hard tabs
Column: 1
(MD010, no-hard-tabs)
116-116: Hard tabs
Column: 1
(MD010, no-hard-tabs)
117-117: Hard tabs
Column: 1
(MD010, no-hard-tabs)
118-118: Hard tabs
Column: 1
(MD010, no-hard-tabs)
119-119: Hard tabs
Column: 1
(MD010, no-hard-tabs)
120-120: Hard tabs
Column: 1
(MD010, no-hard-tabs)
121-121: Hard tabs
Column: 1
(MD010, no-hard-tabs)
122-122: Hard tabs
Column: 1
(MD010, no-hard-tabs)
123-123: Hard tabs
Column: 1
(MD010, no-hard-tabs)
124-124: Hard tabs
Column: 1
(MD010, no-hard-tabs)
125-125: Hard tabs
Column: 1
(MD010, no-hard-tabs)
126-126: Hard tabs
Column: 1
(MD010, no-hard-tabs)
127-127: Hard tabs
Column: 1
(MD010, no-hard-tabs)
128-128: Hard tabs
Column: 1
(MD010, no-hard-tabs)
129-129: Hard tabs
Column: 1
(MD010, no-hard-tabs)
131-131: Hard tabs
Column: 1
(MD010, no-hard-tabs)
132-132: Hard tabs
Column: 1
(MD010, no-hard-tabs)
132-132: Hard tabs
Column: 5
(MD010, no-hard-tabs)
133-133: Hard tabs
Column: 1
(MD010, no-hard-tabs)
134-134: Hard tabs
Column: 1
(MD010, no-hard-tabs)
136-136: Hard tabs
Column: 1
(MD010, no-hard-tabs)
137-137: Hard tabs
Column: 1
(MD010, no-hard-tabs)
141-141: Hard tabs
Column: 1
(MD010, no-hard-tabs)
152-152: Hard tabs
Column: 1
(MD010, no-hard-tabs)
153-153: Hard tabs
Column: 1
(MD010, no-hard-tabs)
154-154: Hard tabs
Column: 1
(MD010, no-hard-tabs)
155-155: Hard tabs
Column: 1
(MD010, no-hard-tabs)
156-156: Hard tabs
Column: 1
(MD010, no-hard-tabs)
157-157: Hard tabs
Column: 1
(MD010, no-hard-tabs)
🪛 LanguageTool
content/en/docs/language/hugegraph-example.md
[style] ~13-~13: Consider using a different adverb to strengthen your wording.
Context: ...e and interfaces. However, HugeGraph is a completely new design and development, characteriz...
(COMPLETELY_ENTIRELY)
[grammar] ~52-~52: Possible agreement error. The noun ‘source’ seems to be countable; consider using: “pair of sources”.
Context: ...ph, each edge label can only act on one pair of source and target vertex labels. In other word...
(A_COLLECTIVE_OF_NN)
🔇 Additional comments (4)
content/cn/docs/quickstart/client/hugegraph-client-go.md (1)
16-17: 验证 Go 模块路径
请确认go get github.com/apache/incubator-hugegraph-toolchain/hugegraph-client-go中的仓库路径和模块名与实际 SDK 发布一致，避免文档失效。content/en/docs/quickstart/client/hugegraph-client-go.md (1)
16-17: 验证 Go 模块路径
go get github.com/apache/incubator-hugegraph-toolchain/hugegraph-client-go的路径应与发布的模块路径保持一致，请确认仓库名和模块声明未发生变更。content/en/docs/language/hugegraph-example.md (2)
33-33: 此处翻译清晰，无需调整
该句英文描述准确、易读，可以保留现状。
121-121: 此处描述准确，无需修改
关于primaryKeysID 策略的说明清晰，可保持原样。
There was a problem hiding this comment.
Actionable comments posted: 3
🔭 Outside diff range comments (1)
content/en/docs/quickstart/client/hugegraph-client-go.md (1)
161-164: 🛠️ Refactor suggestion完善 API Reference 部分
API Reference章节目前仅为占位注释，请补充实际的 API 文档链接或引用，如指向 SDK 的 GoDoc、GitHub 仓库或在线接口文档，方便用户深入了解。
🧹 Nitpick comments (1)
content/en/docs/quickstart/client/hugegraph-client-go.md (1)
147-159: 统一版本响应结构体命名示例中先后使用了
VersionInfo与VersionResponse，建议统一为单一名称（如VersionResponse），并与 SDK 定义保持一致，以免用户混淆。🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
152-152: Hard tabs
Column: 1(MD010, no-hard-tabs)
153-153: Hard tabs
Column: 1(MD010, no-hard-tabs)
154-154: Hard tabs
Column: 1(MD010, no-hard-tabs)
155-155: Hard tabs
Column: 1(MD010, no-hard-tabs)
156-156: Hard tabs
Column: 1(MD010, no-hard-tabs)
157-157: Hard tabs
Column: 1(MD010, no-hard-tabs)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (6)
content/cn/docs/quickstart/client/hugegraph-client-go.md(1 hunks)content/cn/docs/quickstart/client/hugegraph-client-python.md(1 hunks)content/cn/docs/quickstart/client/hugegraph-client.md(2 hunks)content/en/docs/quickstart/client/hugegraph-client-go.md(1 hunks)content/en/docs/quickstart/client/hugegraph-client-python.md(1 hunks)content/en/docs/quickstart/client/hugegraph-client.md(2 hunks)
🚧 Files skipped from review as they are similar to previous changes (5)
- content/cn/docs/quickstart/client/hugegraph-client.md
- content/en/docs/quickstart/client/hugegraph-client-python.md
- content/cn/docs/quickstart/client/hugegraph-client-python.md
- content/cn/docs/quickstart/client/hugegraph-client-go.md
- content/en/docs/quickstart/client/hugegraph-client.md
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
content/en/docs/quickstart/client/hugegraph-client-go.md
34-34: Hard tabs
Column: 1
(MD010, no-hard-tabs)
35-35: Hard tabs
Column: 1
(MD010, no-hard-tabs)
37-37: Hard tabs
Column: 1
(MD010, no-hard-tabs)
38-38: Hard tabs
Column: 1
(MD010, no-hard-tabs)
42-42: Hard tabs
Column: 1
(MD010, no-hard-tabs)
43-43: Hard tabs
Column: 1
(MD010, no-hard-tabs)
44-44: Hard tabs
Column: 1
(MD010, no-hard-tabs)
45-45: Hard tabs
Column: 1
(MD010, no-hard-tabs)
46-46: Hard tabs
Column: 1
(MD010, no-hard-tabs)
47-47: Hard tabs
Column: 1
(MD010, no-hard-tabs)
48-48: Hard tabs
Column: 1
(MD010, no-hard-tabs)
49-49: Hard tabs
Column: 1
(MD010, no-hard-tabs)
50-50: Hard tabs
Column: 1
(MD010, no-hard-tabs)
51-51: Hard tabs
Column: 1
(MD010, no-hard-tabs)
52-52: Hard tabs
Column: 1
(MD010, no-hard-tabs)
53-53: Hard tabs
Column: 1
(MD010, no-hard-tabs)
55-55: Hard tabs
Column: 1
(MD010, no-hard-tabs)
56-56: Hard tabs
Column: 1
(MD010, no-hard-tabs)
57-57: Hard tabs
Column: 1
(MD010, no-hard-tabs)
59-59: Hard tabs
Column: 1
(MD010, no-hard-tabs)
60-60: Hard tabs
Column: 1
(MD010, no-hard-tabs)
72-72: Hard tabs
Column: 1
(MD010, no-hard-tabs)
73-73: Hard tabs
Column: 1
(MD010, no-hard-tabs)
74-74: Hard tabs
Column: 1
(MD010, no-hard-tabs)
76-76: Hard tabs
Column: 1
(MD010, no-hard-tabs)
77-77: Hard tabs
Column: 1
(MD010, no-hard-tabs)
82-82: Hard tabs
Column: 1
(MD010, no-hard-tabs)
83-83: Hard tabs
Column: 1
(MD010, no-hard-tabs)
84-84: Hard tabs
Column: 1
(MD010, no-hard-tabs)
85-85: Hard tabs
Column: 1
(MD010, no-hard-tabs)
86-86: Hard tabs
Column: 1
(MD010, no-hard-tabs)
87-87: Hard tabs
Column: 1
(MD010, no-hard-tabs)
88-88: Hard tabs
Column: 1
(MD010, no-hard-tabs)
89-89: Hard tabs
Column: 1
(MD010, no-hard-tabs)
90-90: Hard tabs
Column: 1
(MD010, no-hard-tabs)
91-91: Hard tabs
Column: 1
(MD010, no-hard-tabs)
92-92: Hard tabs
Column: 1
(MD010, no-hard-tabs)
93-93: Hard tabs
Column: 1
(MD010, no-hard-tabs)
94-94: Hard tabs
Column: 1
(MD010, no-hard-tabs)
95-95: Hard tabs
Column: 1
(MD010, no-hard-tabs)
96-96: Hard tabs
Column: 1
(MD010, no-hard-tabs)
97-97: Hard tabs
Column: 1
(MD010, no-hard-tabs)
101-101: Hard tabs
Column: 1
(MD010, no-hard-tabs)
102-102: Hard tabs
Column: 1
(MD010, no-hard-tabs)
103-103: Hard tabs
Column: 1
(MD010, no-hard-tabs)
104-104: Hard tabs
Column: 1
(MD010, no-hard-tabs)
105-105: Hard tabs
Column: 1
(MD010, no-hard-tabs)
106-106: Hard tabs
Column: 1
(MD010, no-hard-tabs)
107-107: Hard tabs
Column: 1
(MD010, no-hard-tabs)
108-108: Hard tabs
Column: 1
(MD010, no-hard-tabs)
109-109: Hard tabs
Column: 1
(MD010, no-hard-tabs)
110-110: Hard tabs
Column: 1
(MD010, no-hard-tabs)
111-111: Hard tabs
Column: 1
(MD010, no-hard-tabs)
112-112: Hard tabs
Column: 1
(MD010, no-hard-tabs)
113-113: Hard tabs
Column: 1
(MD010, no-hard-tabs)
115-115: Hard tabs
Column: 1
(MD010, no-hard-tabs)
116-116: Hard tabs
Column: 1
(MD010, no-hard-tabs)
117-117: Hard tabs
Column: 1
(MD010, no-hard-tabs)
118-118: Hard tabs
Column: 1
(MD010, no-hard-tabs)
119-119: Hard tabs
Column: 1
(MD010, no-hard-tabs)
120-120: Hard tabs
Column: 1
(MD010, no-hard-tabs)
121-121: Hard tabs
Column: 1
(MD010, no-hard-tabs)
122-122: Hard tabs
Column: 1
(MD010, no-hard-tabs)
123-123: Hard tabs
Column: 1
(MD010, no-hard-tabs)
124-124: Hard tabs
Column: 1
(MD010, no-hard-tabs)
125-125: Hard tabs
Column: 1
(MD010, no-hard-tabs)
126-126: Hard tabs
Column: 1
(MD010, no-hard-tabs)
127-127: Hard tabs
Column: 1
(MD010, no-hard-tabs)
128-128: Hard tabs
Column: 1
(MD010, no-hard-tabs)
129-129: Hard tabs
Column: 1
(MD010, no-hard-tabs)
131-131: Hard tabs
Column: 1
(MD010, no-hard-tabs)
132-132: Hard tabs
Column: 1
(MD010, no-hard-tabs)
132-132: Hard tabs
Column: 5
(MD010, no-hard-tabs)
133-133: Hard tabs
Column: 1
(MD010, no-hard-tabs)
134-134: Hard tabs
Column: 1
(MD010, no-hard-tabs)
136-136: Hard tabs
Column: 1
(MD010, no-hard-tabs)
137-137: Hard tabs
Column: 1
(MD010, no-hard-tabs)
141-141: Hard tabs
Column: 1
(MD010, no-hard-tabs)
152-152: Hard tabs
Column: 1
(MD010, no-hard-tabs)
153-153: Hard tabs
Column: 1
(MD010, no-hard-tabs)
154-154: Hard tabs
Column: 1
(MD010, no-hard-tabs)
155-155: Hard tabs
Column: 1
(MD010, no-hard-tabs)
156-156: Hard tabs
Column: 1
(MD010, no-hard-tabs)
157-157: Hard tabs
Column: 1
(MD010, no-hard-tabs)
🔇 Additional comments (3)
content/en/docs/quickstart/client/hugegraph-client-go.md (3)
30-62: 初始化客户端示例无误代码示例结构清晰，依照 Go 规范进行了错误处理并避免未使用警告，符合最佳实践。
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
34-34: Hard tabs
Column: 1(MD010, no-hard-tabs)
35-35: Hard tabs
Column: 1(MD010, no-hard-tabs)
37-37: Hard tabs
Column: 1(MD010, no-hard-tabs)
38-38: Hard tabs
Column: 1(MD010, no-hard-tabs)
42-42: Hard tabs
Column: 1(MD010, no-hard-tabs)
43-43: Hard tabs
Column: 1(MD010, no-hard-tabs)
44-44: Hard tabs
Column: 1(MD010, no-hard-tabs)
45-45: Hard tabs
Column: 1(MD010, no-hard-tabs)
46-46: Hard tabs
Column: 1(MD010, no-hard-tabs)
47-47: Hard tabs
Column: 1(MD010, no-hard-tabs)
48-48: Hard tabs
Column: 1(MD010, no-hard-tabs)
49-49: Hard tabs
Column: 1(MD010, no-hard-tabs)
50-50: Hard tabs
Column: 1(MD010, no-hard-tabs)
51-51: Hard tabs
Column: 1(MD010, no-hard-tabs)
52-52: Hard tabs
Column: 1(MD010, no-hard-tabs)
53-53: Hard tabs
Column: 1(MD010, no-hard-tabs)
55-55: Hard tabs
Column: 1(MD010, no-hard-tabs)
56-56: Hard tabs
Column: 1(MD010, no-hard-tabs)
57-57: Hard tabs
Column: 1(MD010, no-hard-tabs)
59-59: Hard tabs
Column: 1(MD010, no-hard-tabs)
60-60: Hard tabs
Column: 1(MD010, no-hard-tabs)
1-5:Details
✅ Verification successful
校验前端元数据 (Frontmatter) 完整性
请确认
title、linkTitle、weight等 frontmatter 字段是否满足项目文档规范（例如是否还需description、aliases等），并与其他语言版本保持一致，确保在导航和菜单中正确显示。
🏁 Script executed:
#!/bin/bash # 验证中文版本文档是否已创建 fd 'hugegraph-client-go.md' content/cn/docs/quickstart/clientLength of output: 118
🏁 Script executed:
#!/bin/bash # 输出所有客户端快速入门文档的前端元数据以便比对 for file in content/en/docs/quickstart/client/*.md content/cn/docs/quickstart/client/*.md; do echo "=== $file ===" sed -n '1,20p' "$file" echo doneLength of output: 5874
frontmatter 字段一致且完整
已验证
content/en/docs/quickstart/client/hugegraph-client-go.md与对应的中文版本前端元数据（title、linkTitle、weight）与其他客户端快速入门文档保持一致。项目中未见需强制添加description或aliases字段，当前元数据符合规范，无需修改。
15-17:Details
❓ Verification inconclusive
验证安装命令和模块路径正确性
请确认以下安装命令在最新代码仓库中可用，并且模块路径
github.com/apache/incubator-hugegraph-toolchain/hugegraph-client-go对应 SDK 代码库：
🏁 Script executed:
go get github.com/apache/incubator-hugegraph-toolchain/hugegraph-client-goLength of output: 529
执行以下脚本以验证仓库是否存在，以及
go.mod中的模块路径是否正确：
🏁 Script executed:
#!/bin/bash # 检查 go.mod 是否存在及模块路径 status=$(curl -s -o /dev/null -w "%{http_code}" https://raw.githubusercontent.com/apache/incubator-hugegraph-toolchain/hugegraph-client-go/main/go.mod) echo "HTTP 状态码: $status" if [ "$status" = "200" ]; then echo "go.mod 中的 module 定义：" curl -s https://raw.githubusercontent.com/apache/incubator-hugegraph-toolchain/hugegraph-client-go/main/go.mod | grep '^module' else echo "无法获取 go.mod，请手动确认仓库路径或分支是否正确。" fiLength of output: 283
请执行下面脚本，确认 Apache 组织下正确的仓库全名：
🏁 Script executed:
#!/bin/bash # 在 Apache 组织中搜索包含 hugegraph-client-go 的仓库 curl -s "https://api.github.com/search/repositories?q=hugegraph-client-go+org:apache" \ | grep '"full_name"' \ | sed -E 's/.*"([^"]+)".*/\1/'Length of output: 139
验证安装命令和模块路径
由于go get在模块外部已废弃，且无法在仓库中找到incubator-hugegraph-toolchain/hugegraph-client-go，请手动确认 SDK 在 GitHub 上的正确仓库地址及模块路径，并在文档中使用 Go 1.17+ 推荐的go install命令：go install <正确的模块路径>@latest
- 检查 GitHub “apache” 组织下对应的仓库全名
- 确认该仓库根目录下
go.mod中的module定义与文档路径一致- 将文档示例由
go get改为go install格式，以保证在最新 Go 版本中可用
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (3)
content/cn/docs/quickstart/hugegraph-ai/quick_start.md (1)
76-84: 括号样式已在前文评论中指出，请统一使用全角括号。content/cn/docs/quickstart/hugegraph-ai/_index.md (1)
33-42: Docker 镜像与 HugeGraph Server 版本兼容性建议已在环境要求（Server 1.3+）中部分体现。content/en/docs/quickstart/hugegraph-ai/_index.md (1)
26-30: 🛠️ Refactor suggestion补充系统资源需求说明。
建议在环境要求中增加最小系统资源，例如：- Minimum 4 GB RAM (recommended) - At least 2 CPU cores
🧹 Nitpick comments (26)
content/cn/docs/quickstart/hugegraph-ai/quick_start.md (8)
1-5: 本地化文档元数据Frontmatter 中
title、linkTitle为英文，应翻译为中文以保持与文件语言一致，例如将GraphRAG UI Details改为GraphRAG UI 详情。
7-7: 优化引言措辞“接续主文档介绍基础 UI 功能及详情”中的“接续”用词略显生硬，建议改为“承接”或“以下内容承接主文档”，提升可读性。
16-19: 统一括号样式“(Graph)RAG” 使用了半角括号，中文文档中建议统一使用全角括号“（Graph）RAG”。
21-25: 精炼流程描述“从文本构建知识图谱、分块向量和图顶点向量”中“向量”一词重复，建议改为“从文本构建知识图谱、生成文本向量及图顶点向量”，逻辑更清晰。
28-39: 简化 Mermaid 图示
- 节点
A --> B[文本分割]与A --> F[文本分割]重复，建议合并或重命名以突出不同流程。\n换行标记在部分渲染器中可能不生效，建议使用<br/>或者多行标签。
42-47: 统一术语格式“Schema” 一词在列表中出现多次，建议统一格式（如均使用粗体 Schema 或中文“模式”），保持术语一致性。
51-61: 调整列表缩进“按钮”列表的子项应与父项缩进保持一致（两个空格），并在不同父项之间空一行以提升可读性。例如：
- **获取 RAG 信息** - **获取向量索引信息** - **获取图索引信息** - **清除 RAG 数据** - **清除分块向量索引** - **清除图顶点向量索引** - **清除图数据**🧰 Tools
🪛 LanguageTool
[uncategorized] ~58-~58: 您的意思是“"不"和”？
Context: ...向量） - 提取图数据 (1)： 基于 Schema，使用图提取提示词头部和分块内容作为提示词，从文档中提取图数据 - 加载到图数据库 (2)： ...(BU)
67-74: 优化示例流程标注建议将按钮名称用反引号包裹，如 `导入到向量`、`提取图数据 (1)` 等，以区分 UI 元素与正文，提高可读性。
content/cn/docs/quickstart/hugegraph-ai/_index.md (4)
1-5: 本地化文档元数据Frontmatter 中
title、linkTitle为英文，建议翻译为中文，如HugeGraph-AI 概览，以与文档语言保持一致。
21-23: 统一括号样式“使用自然语言操作图数据库 (Gremlin/Cypher)”中的半角括号建议统一为全角：
使用自然语言操作图数据库（Gremlin/Cypher）。
25-30: 补充系统资源要求建议在环境要求中添加最低系统资源说明（如至少 4 GB RAM、2 个 CPU 核心），以便生产部署参考。
43-61: 添加常见故障排查建议在 Docker 部署后增加“故障排查”小节，涵盖端口冲突、内存不足等常见问题及解决方案，提升用户体验。
content/en/docs/quickstart/hugegraph-ai/_index.md (8)
7-7: 优化引用提示语句流畅度。
建议将本行拆成两句或重构为：-> Please refer to the AI repository [README](https://github.com/apache/incubator-hugegraph-ai/tree/main/hugegraph-llm#readme) for the most up-to-date documentation. -> The official website is regularly updated and synchronized.
36-44: 调整列表缩进以符合 markdownlint 要求。
目前多处嵌套列表缩进不一致，会触发 MD007 警告，建议统一按 2 或 4 个空格缩进。🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
38-38: Unordered list indentation
Expected: 0; Actual: 3(MD007, ul-indent)
39-39: Unordered list indentation
Expected: 0; Actual: 3(MD007, ul-indent)
40-40: Unordered list indentation
Expected: 2; Actual: 5(MD007, ul-indent)
42-42: Unordered list indentation
Expected: 2; Actual: 5(MD007, ul-indent)
44-44: Unordered list indentation
Expected: 0; Actual: 3(MD007, ul-indent)
54-62: 示例命令中 URL 建议使用链接文本。
将裸露 URLhttp://localhost:8001改为[http://localhost:8001](http://localhost:8001)可以避免 MD034 警告。🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
54-54: Unordered list indentation
Expected: 0; Actual: 3(MD007, ul-indent)
62-62: Unordered list indentation
Expected: 0; Actual: 3(MD007, ul-indent)
62-62: Bare URL used
null(MD034, no-bare-urls)
64-67: 优化 Build from Source 描述。
第 1 步可改为：- 1. Start the HugeGraph database, you can run it via Docker: + 1. Start the HugeGraph database using Docker:🧰 Tools
🪛 LanguageTool
[uncategorized] ~66-~66: Possible missing preposition found.
Context: ...ost:8001 ### 3.2 Build from Source 1. Start the HugeGraph database, you can run it ...(AI_HYDRA_LEO_MISSING_TO)
73-77: 修正逗号拼接与大小写。
建议将“Configuring the uv environment, Use the official installer…”改为：- 2. Configuring the uv environment, Use the official installer to install uv… + 2. Configure the uv environment. Use the official installer to install uv…
91-98: 替换裸露 URL 为链接文本。
如将http://127.0.0.1:8001修改为[http://127.0.0.1:8001](http://127.0.0.1:8001)，避免 MD034 警告。🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
91-91: Bare URL used
null(MD034, no-bare-urls)
106-107: 统一强调语法及动词形式。
建议将Litellm改为 Litellm，并将 “support multi-LLM provider” 改为 “supports multiple LLM providers”。🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
107-107: Strong style
Expected: asterisk; Actual: underscore(MD050, strong-style)
107-107: Strong style
Expected: asterisk; Actual: underscore(MD050, strong-style)
116-117: 替换裸露 URL 为链接文本。
建议将链接文字描述化，如：> You can also refer to our [quick-start guide](https://github.com/apache/incubator-hugegraph-ai/blob/main/hugegraph-llm/quick_start.md).content/en/docs/quickstart/hugegraph-ai/quick_start.md (6)
7-7: 优化引导语句。
建议将：- Follow up [main doc](../) to introduce the basic UI function & details… + Refer to the [main doc](../) for basic UI functions and details…🧰 Tools
🪛 LanguageTool
[uncategorized] ~7-~7: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...ain doc](../) to introduce the basic UI function & details, welcome to update and improv...(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
9-15: 职责列表补全标点。
各项职责建议统一末尾使用句号，以增强一致性。
22-22: “vid” 用词不够专业。
建议将 “graph vid vector” 改为 “graph vertex ID vector” 或类似更正式的术语。🧰 Tools
🪛 LanguageTool
[style] ~22-~22: ‘vid’ is informal. Consider replacing it.
Context: ...nowledge graph, chunk vector, and graph vid vector from the text. 
40-63: 统一按钮与字段命名格式。
建议将 “Doc(s)” 改为 “Document(s)”，并统一加粗与空格用法，保持文档整体一致性。🧰 Tools
🪛 LanguageTool
[style] ~57-~57: ‘Vid’ is informal. Consider replacing it.
Context: ...** Clear chunk vector - Clear Graph Vid Vector Index: Clear graph vid vector ...(VID)
[style] ~57-~57: ‘vid’ is informal. Consider replacing it.
Context: ...r Graph Vid Vector Index**: Clear graph vid vector - Clear Graph Data: Clear ...(VID)
[style] ~61-~61: ‘Vid’ is informal. Consider replacing it.
Context: ...he database (automatically calls Update Vid Embedding to store vectors in the vecto...(VID)
[style] ~62-~62: ‘Vid’ is informal. Consider replacing it.
Context: ...tors in the vector database) - Update Vid Embedding: Convert graph vid into vec...(VID)
[style] ~62-~62: ‘vid’ is informal. Consider replacing it.
Context: ...Update Vid Embedding: Convert graph vid into vectors ### Execution Flow: 1. I...(VID)
64-72: 标题层级建议下调。
“Execution Flow” 作为子模块，可考虑改为三级标题（###），提高文档层级逻辑一致性。🧰 Tools
🪛 LanguageTool
[style] ~70-~70: ‘Vid’ is informal. Consider replacing it.
Context: ...base (this automatically calls Update Vid Embedding to store the vectors in the...(VID)
[style] ~71-~71: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...the vectors in the vector database). 6. Click the Update Vid Embedding bu...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~71-~71: ‘Vid’ is informal. Consider replacing it.
Context: ...or database). 6. Click the Update Vid Embedding button to vectorize the...(VID)
73-85: 统一 RAG 首字母大写与按钮样式。
建议对 “Import into Vector”、“Update Vid Embedding” 等按钮名称统一使用英文双引号或强调格式，并确保“RAG”大写一致。🧰 Tools
🪛 LanguageTool
[style] ~75-~75: ‘Vid’ is informal. Consider replacing it.
Context: ...(chunks) into vectors, and the Update Vid Embedding button converts graph vid i...(VID)
[style] ~75-~75: ‘vid’ is informal. Consider replacing it.
Context: ...e Vid Embedding** button converts graph vid into vectors. These vectors are stored ...(VID)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (5)
content/cn/docs/quickstart/computing/hugegraph-computer.md(7 hunks)content/cn/docs/quickstart/hugegraph-ai/_index.md(1 hunks)content/cn/docs/quickstart/hugegraph-ai/quick_start.md(1 hunks)content/en/docs/quickstart/hugegraph-ai/_index.md(5 hunks)content/en/docs/quickstart/hugegraph-ai/quick_start.md(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- content/cn/docs/quickstart/computing/hugegraph-computer.md
🧰 Additional context used
🪛 LanguageTool
content/cn/docs/quickstart/hugegraph-ai/quick_start.md
[uncategorized] ~58-~58: 您的意思是“"不"和”？
Context: ...向量） - 提取图数据 (1)： 基于 Schema，使用图提取提示词头部和分块内容作为提示词，从文档中提取图数据 - 加载到图数据库 (2)： ...
(BU)
content/cn/docs/quickstart/hugegraph-ai/_index.md
[uncategorized] ~115-~115: 动词的修饰一般为‘形容词（副词）+地+动词’。您的意思是否是：基本"地"查询
Context: ...ugegraph-llm/quick_start.md)文档来了解如何使用它以及基本的查询逻辑 🚧 ## 4. 示例 ### 4.1 通过 LLM 在 Hu...
(wb4)
content/en/docs/quickstart/hugegraph-ai/_index.md
[uncategorized] ~66-~66: Possible missing preposition found.
Context: ...ost:8001 ### 3.2 Build from Source 1. Start the HugeGraph database, you can run it ...
(AI_HYDRA_LEO_MISSING_TO)
content/en/docs/quickstart/hugegraph-ai/quick_start.md
[uncategorized] ~7-~7: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...ain doc](../) to introduce the basic UI function & details, welcome to update and improv...
(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
[style] ~22-~22: ‘vid’ is informal. Consider replacing it.
Context: ...nowledge graph, chunk vector, and graph vid vector from the text. 
[style] ~57-~57: ‘Vid’ is informal. Consider replacing it.
Context: ...** Clear chunk vector - Clear Graph Vid Vector Index: Clear graph vid vector ...
(VID)
[style] ~57-~57: ‘vid’ is informal. Consider replacing it.
Context: ...r Graph Vid Vector Index**: Clear graph vid vector - Clear Graph Data: Clear ...
(VID)
[style] ~61-~61: ‘Vid’ is informal. Consider replacing it.
Context: ...he database (automatically calls Update Vid Embedding to store vectors in the vecto...
(VID)
[style] ~62-~62: ‘Vid’ is informal. Consider replacing it.
Context: ...tors in the vector database) - Update Vid Embedding: Convert graph vid into vec...
(VID)
[style] ~62-~62: ‘vid’ is informal. Consider replacing it.
Context: ...Update Vid Embedding: Convert graph vid into vectors ### Execution Flow: 1. I...
(VID)
[style] ~70-~70: ‘Vid’ is informal. Consider replacing it.
Context: ...base (this automatically calls Update Vid Embedding to store the vectors in the...
(VID)
[style] ~71-~71: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...the vectors in the vector database). 6. Click the Update Vid Embedding bu...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~71-~71: ‘Vid’ is informal. Consider replacing it.
Context: ...or database). 6. Click the Update Vid Embedding button to vectorize the...
(VID)
[style] ~75-~75: ‘Vid’ is informal. Consider replacing it.
Context: ...(chunks) into vectors, and the Update Vid Embedding button converts graph vid i...
(VID)
[style] ~75-~75: ‘vid’ is informal. Consider replacing it.
Context: ...e Vid Embedding** button converts graph vid into vectors. These vectors are stored ...
(VID)
[duplication] ~105-~105: Possible typo: you repeated a word.
Context: ...nput Fields: - Question: Input the query - Query Prompt: The prompt template used ...
(ENGLISH_WORD_REPEAT_RULE)
[style] ~114-~114: ‘vid’ is informal. Consider replacing it.
Context: ...ly graph-based retrieval (queries graph vid vectors in the vector database and the ...
(VID)
[style] ~132-~132: ‘vid’ is informal. Consider replacing it.
Context: ...zzy match in the vector database (graph vid vector) to retrieve relevant vertices. ...
(VID)
[uncategorized] ~134-~134: Possible missing comma found.
Context: ...nterface, using the matched vertices as entities to convert the question into a Grem...
(AI_HYDRA_LEO_MISSING_COMMA)
🪛 markdownlint-cli2 (0.17.2)
content/en/docs/quickstart/hugegraph-ai/_index.md
8-8: Blank line inside blockquote
null
(MD028, no-blanks-blockquote)
38-38: Unordered list indentation
Expected: 0; Actual: 3
(MD007, ul-indent)
39-39: Unordered list indentation
Expected: 0; Actual: 3
(MD007, ul-indent)
40-40: Unordered list indentation
Expected: 2; Actual: 5
(MD007, ul-indent)
42-42: Unordered list indentation
Expected: 2; Actual: 5
(MD007, ul-indent)
44-44: Unordered list indentation
Expected: 0; Actual: 3
(MD007, ul-indent)
49-49: Unordered list indentation
Expected: 0; Actual: 3
(MD007, ul-indent)
54-54: Unordered list indentation
Expected: 0; Actual: 3
(MD007, ul-indent)
62-62: Unordered list indentation
Expected: 0; Actual: 3
(MD007, ul-indent)
62-62: Bare URL used
null
(MD034, no-bare-urls)
91-91: Bare URL used
null
(MD034, no-bare-urls)
107-107: Strong style
Expected: asterisk; Actual: underscore
(MD050, strong-style)
107-107: Strong style
Expected: asterisk; Actual: underscore
(MD050, strong-style)
111-111: Strong style
Expected: asterisk; Actual: underscore
(MD050, strong-style)
111-111: Strong style
Expected: asterisk; Actual: underscore
(MD050, strong-style)
🔇 Additional comments (13)
content/cn/docs/quickstart/hugegraph-ai/quick_start.md (1)
88-96: RAG 查询流程图结构清晰、逻辑完整，无需修改。content/cn/docs/quickstart/hugegraph-ai/_index.md (2)
7-10: 引用了 AI 仓库 README 及 DeepWiki 徽章，帮助用户获取最新文档，表达清晰。
83-87: 源码构建部分uv pip install -e .与英文文档保持一致，无需修改。content/en/docs/quickstart/hugegraph-ai/_index.md (8)
2-4: 请校验 frontmatter 与其他 Quickstart 文档的一致性。
当前文件的 title、linkTitle 和 weight 已更新，请确认中英文版本及目录中对应文档的 frontmatter 字段保持同步。
9-9: 区块引用徽章展示正常。
深度维基（DeepWiki）徽章渲染正常，无需调整。
11-11: 章节标题格式正确。
“## 1. Summary” 与其他 Quickstart 文档保持一致。
13-25: 段落内容清晰，无需调整。
Summary 段提供了项目背景和目标，结构合理。
32-34: Preparation 标题已更新。
“## 3. Preparation” 及其子标题格式与文档结构一致。
45-48: Docker 拉取镜像示例正确。
示例命令无语法或路径问题。
49-53: Docker 启动容器示例正常。
挂载和端口映射示例清晰可用。🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
49-49: Unordered list indentation
Expected: 0; Actual: 3(MD007, ul-indent)
118-118: 章节标题格式已更新为 “## 4. Examples”。
符合之前反馈要求。content/en/docs/quickstart/hugegraph-ai/quick_start.md (2)
1-5: 请校验 frontmatter 与_index.md同步。
确认 title、linkTitle、weight 与主文档保持一致。
86-99: Mermaid 图表语法正确。
流程示意图可正常渲染，无需调整。
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (7)
content/cn/docs/quickstart/hugegraph-ai/_index.md (7)
1-5: 确认 frontmatter 顺序与英文文档一致
frontmatter 已包含title、linkTitle和weight，请对照英文版导航顺序，确保weight值匹配，从而保证中英文文档在侧边栏的排序一致。
7-10: 精简 blockquote 内部空行
第 8 行为 blockquote 中的空行，建议移除以避免渲染多余间距，保持格式紧凑。🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
8-8: Blank line inside blockquote
null(MD028, no-blanks-blockquote)
39-42: 添加镜像与服务器版本兼容性说明
在镜像说明部分，建议标注每个镜像（hugegraph/rag、hugegraph/rag-bin）对应的 HugeGraph Server 最低兼容版本，帮助用户选择正确组合。
44-47: 补充 Docker 常见故障排查
拉取镜像及运行容器示例之后，可增加常见问题及解决方案，如端口冲突、内存不足、权限等故障排查指引。
61-61: 避免裸露 URL
第 61 行访问接口 http://localhost:8001使用裸露 URL，建议改为[http://localhost:8001](http://localhost:8001)，以提升可点击性并符合 Markdown 最佳实践。🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
61-61: Bare URL used
null(MD034, no-bare-urls)
90-90: 避免裸露 URL
第 90 行中的http://127.0.0.1:8001建议改为[http://127.0.0.1:8001](http://127.0.0.1:8001)，提高可读性和可点击性。🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
90-90: Bare URL used
null(MD034, no-bare-urls)
107-107: 统一加粗语法
第 107 行(__可选__)使用双下划线语法，建议统一改为(**可选**)或(** 可选 **)以符合通用惯例。
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
content/cn/docs/quickstart/hugegraph-ai/_index.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
content/cn/docs/quickstart/hugegraph-ai/_index.md
[uncategorized] ~115-~115: 动词的修饰一般为‘形容词（副词）+地+动词’。您的意思是否是：基本"地"查询
Context: ...ugegraph-llm/quick_start.md)文档来了解如何使用它以及基本的查询逻辑 🚧 ## 4. 示例 ### 4.1 通过 LLM 在 Hu...
(wb4)
🪛 markdownlint-cli2 (0.17.2)
content/cn/docs/quickstart/hugegraph-ai/_index.md
8-8: Blank line inside blockquote
null
(MD028, no-blanks-blockquote)
61-61: Bare URL used
null
(MD034, no-bare-urls)
90-90: Bare URL used
null
(MD034, no-bare-urls)
106-106: Strong style
Expected: asterisk; Actual: underscore
(MD050, strong-style)
106-106: Strong style
Expected: asterisk; Actual: underscore
(MD050, strong-style)
110-110: Strong style
Expected: asterisk; Actual: underscore
(MD050, strong-style)
110-110: Strong style
Expected: asterisk; Actual: underscore
(MD050, strong-style)
🔇 Additional comments (1)
content/cn/docs/quickstart/hugegraph-ai/_index.md (1)
83-87: 确认依赖安装步骤一致性
uv pip install -e .已与英文版保持一致，符合预期，无需调整。
| ```bash | ||
| # 如果遇到网络问题，可以尝试使用 pipx 或 pip 安装 uv，详情请参阅 uv 文档 | ||
| curl -LsSf [https://astral.sh/uv/install.sh](https://astral.sh/uv/install.sh) | sh - # 安装最新版本，如 0.7.3+ | ||
| ``` | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
修正 curl 命令中的方括号
第 75 行示例命令多余地将 URL 用 [] 包裹，执行时会报错，建议按下述方式修改：
- curl -LsSf [https://astral.sh/uv/install.sh] | sh -
+ curl -LsSf https://astral.sh/uv/install.sh | sh -Committable suggestion skipped: line range outside the PR's diff.
🤖 Prompt for AI Agents
In content/cn/docs/quickstart/hugegraph-ai/_index.md around lines 73 to 77, the
curl command incorrectly includes square brackets around the URL, which causes
execution errors. Remove the square brackets from the URL in the curl command so
it reads as a plain URL without any enclosing characters.
There was a problem hiding this comment.
Actionable comments posted: 4
♻️ Duplicate comments (1)
content/en/docs/quickstart/hugegraph-ai/_index.md (1)
26-31: 补充硬件资源需求
“Environment Requirements” 中缺少最低系统资源说明（如最低 4 GB RAM、至少 2 CPU 核心），对生产部署尤为重要。
🧹 Nitpick comments (9)
content/cn/docs/quickstart/hugegraph-ai/_index.md (3)
1-5: 建议在中文页面中添加中文标题
当前文档title和linkTitle均为英文 “HugeGraph-AI”，建议为中文页面补充中文标题（如“HugeGraph-AI 快速开始”），以提升本地化一致性和用户体验。
7-8: 移除引用块内的空白行或保持>前缀一致
第 8 行在两个引用之间留有未加>的空白行，打断了连续引用。建议要么在空行前后都加上>，要么将两段合并为一个引用块。🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
8-8: Blank line inside blockquote
null(MD028, no-blanks-blockquote)
61-61: 规范裸露 URL
第 61 行的http://localhost:8001为裸露 URL，建议改为<http://localhost:8001>或使用 Markdown 链接格式以通过校验。🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
61-61: Bare URL used
null(MD034, no-bare-urls)
content/en/docs/quickstart/hugegraph-ai/_index.md (6)
36-44: 统一列表缩进风格
多处无序列表使用了不一致的缩进（3 或 5 个空格），建议统一改为常见的 2 或 4 个空格，以提升可读性。🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
38-38: Unordered list indentation
Expected: 0; Actual: 3(MD007, ul-indent)
39-39: Unordered list indentation
Expected: 0; Actual: 3(MD007, ul-indent)
40-40: Unordered list indentation
Expected: 2; Actual: 5(MD007, ul-indent)
42-42: Unordered list indentation
Expected: 2; Actual: 5(MD007, ul-indent)
44-44: Unordered list indentation
Expected: 0; Actual: 3(MD007, ul-indent)
50-53: 优化本地路径占位符
挂载示例中使用了path2project/hugegraph-llm/.env，建议统一采用/path/to/.env或${PWD}/.env等更通用的写法，便于读者按需替换。
62-62: 格式化裸露 URL
第 62 行的http://localhost:8001建议改为<http://localhost:8001>或链接形式，以符合 Markdown 校验。🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
62-62: Unordered list indentation
Expected: 0; Actual: 3(MD007, ul-indent)
62-62: Bare URL used
null(MD034, no-bare-urls)
91-91: 格式化裸露 URL
第 91 行的http://127.0.0.1:8001建议改为<http://127.0.0.1:8001>或链接形式。🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
91-91: Bare URL used
null(MD034, no-bare-urls)
107-107: Markdown 强调样式不一致
此处使用了__Optional__，建议统一改为**Optional**，符合星号强调风格。🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
107-107: Strong style
Expected: asterisk; Actual: underscore(MD050, strong-style)
107-107: Strong style
Expected: asterisk; Actual: underscore(MD050, strong-style)
110-110: Markdown 强调样式不一致
同上，这里也应将__Optional__改为**Optional**。
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
content/cn/docs/quickstart/hugegraph-ai/_index.md(1 hunks)content/en/docs/quickstart/hugegraph-ai/_index.md(5 hunks)
🧰 Additional context used
🪛 LanguageTool
content/cn/docs/quickstart/hugegraph-ai/_index.md
[uncategorized] ~115-~115: 动词的修饰一般为‘形容词（副词）+地+动词’。您的意思是否是：基本"地"查询
Context: ...ugegraph-llm/quick_start.md)文档来了解如何使用它以及基本的查询逻辑 🚧 ## 4. 示例 ### 4.1 通过 LLM 在 Hu...
(wb4)
content/en/docs/quickstart/hugegraph-ai/_index.md
[uncategorized] ~66-~66: Possible missing preposition found.
Context: ...ost:8001 ### 3.2 Build from Source 1. Start the HugeGraph database, you can run it ...
(AI_HYDRA_LEO_MISSING_TO)
🪛 markdownlint-cli2 (0.17.2)
content/cn/docs/quickstart/hugegraph-ai/_index.md
8-8: Blank line inside blockquote
null
(MD028, no-blanks-blockquote)
61-61: Bare URL used
null
(MD034, no-bare-urls)
90-90: Bare URL used
null
(MD034, no-bare-urls)
106-106: Strong style
Expected: asterisk; Actual: underscore
(MD050, strong-style)
106-106: Strong style
Expected: asterisk; Actual: underscore
(MD050, strong-style)
110-110: Strong style
Expected: asterisk; Actual: underscore
(MD050, strong-style)
110-110: Strong style
Expected: asterisk; Actual: underscore
(MD050, strong-style)
content/en/docs/quickstart/hugegraph-ai/_index.md
8-8: Blank line inside blockquote
null
(MD028, no-blanks-blockquote)
38-38: Unordered list indentation
Expected: 0; Actual: 3
(MD007, ul-indent)
39-39: Unordered list indentation
Expected: 0; Actual: 3
(MD007, ul-indent)
40-40: Unordered list indentation
Expected: 2; Actual: 5
(MD007, ul-indent)
42-42: Unordered list indentation
Expected: 2; Actual: 5
(MD007, ul-indent)
44-44: Unordered list indentation
Expected: 0; Actual: 3
(MD007, ul-indent)
49-49: Unordered list indentation
Expected: 0; Actual: 3
(MD007, ul-indent)
54-54: Unordered list indentation
Expected: 0; Actual: 3
(MD007, ul-indent)
62-62: Unordered list indentation
Expected: 0; Actual: 3
(MD007, ul-indent)
62-62: Bare URL used
null
(MD034, no-bare-urls)
91-91: Bare URL used
null
(MD034, no-bare-urls)
107-107: Strong style
Expected: asterisk; Actual: underscore
(MD050, strong-style)
107-107: Strong style
Expected: asterisk; Actual: underscore
(MD050, strong-style)
111-111: Strong style
Expected: asterisk; Actual: underscore
(MD050, strong-style)
111-111: Strong style
Expected: asterisk; Actual: underscore
(MD050, strong-style)
🔇 Additional comments (1)
content/en/docs/quickstart/hugegraph-ai/_index.md (1)
216-216: 验证参数名称一致性
示例中将max_items更名为max_graph_items，请确认项目中所有示例与实现均已同步更新，避免示例与实现在参数名称上的不一致。
| ## 2. 环境要求 | ||
| > [!IMPORTANT] | ||
| > - python 3.10+ (未在 3.12 中测试) | ||
| > - hugegraph-server 1.3+ (建议使用 1.5+) | ||
| > - uv 0.7+ | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
补充最低系统资源要求
“环境要求”中只列出了 Python、HugeGraph Server 和 uv 版本，缺少硬件资源说明（如最低 4 GB RAM、至少 2 CPU 核心），建议补充以帮助生产环境部署评估。
🤖 Prompt for AI Agents
In content/cn/docs/quickstart/hugegraph-ai/_index.md around lines 25 to 30, the
environment requirements section currently lists only software versions but
lacks minimum hardware resource specifications. Add details about minimum system
resources such as at least 4 GB of RAM and 2 CPU cores to provide clearer
guidance for production environment deployment.
| ```bash | ||
| git clone [https://github.com/apache/incubator-hugegraph-ai.git](https://github.com/apache/incubator-hugegraph-ai.git) | ||
| ``` |
There was a problem hiding this comment.
🛠️ Refactor suggestion
移除 git clone 命令中的 Markdown 链接语法
第 80–81 行的克隆命令不应使用 [url](url) 形式，建议改为：
git clone https://github.com/apache/incubator-hugegraph-ai.git🤖 Prompt for AI Agents
In content/cn/docs/quickstart/hugegraph-ai/_index.md around lines 79 to 81, the
git clone command uses Markdown link syntax which is incorrect for shell
commands. Remove the square brackets and parentheses so the command is a plain
URL, changing it to: git clone
https://github.com/apache/incubator-hugegraph-ai.git.
| 2. 配置 uv 环境，使用官方安装器安装 uv，其他安装方法请参见 [uv 文档](https://docs.astral.sh/uv/configuration/installer/)。 | ||
| ```bash | ||
| # 如果遇到网络问题，可以尝试使用 pipx 或 pip 安装 uv，详情请参阅 uv 文档 | ||
| curl -LsSf [https://astral.sh/uv/install.sh](https://astral.sh/uv/install.sh) | sh - # 安装最新版本，如 0.7.3+ |
There was a problem hiding this comment.
🛠️ Refactor suggestion
修复 curl 命令中的方括号
第 75 行示例多余地将 URL 用 [] 包裹，会导致执行失败。应改为：
curl -LsSf https://astral.sh/uv/install.sh | sh -🤖 Prompt for AI Agents
In content/cn/docs/quickstart/hugegraph-ai/_index.md at line 75, the curl
command incorrectly includes square brackets around the URL, which causes
execution failure. Remove the square brackets so the command reads: curl -LsSf
https://astral.sh/uv/install.sh | sh - to fix the issue.
| ## 1 HugeGraph-AI Overview | ||
| hugegraph-ai aims to explore the integration of HugeGraph and artificial intelligence (AI), including applications combined | ||
| with large models, integration with graph machine learning components, etc., to provide comprehensive support for developers to use HugeGraph's AI capabilities in projects. | ||
| > Please refer to the AI repository [README](https://github.com/apache/incubator-hugegraph-ai/tree/main/hugegraph-llm#readme) for the most up-to-date documentation, and the official website **regularly** is updated and synchronized. |
There was a problem hiding this comment.
🛠️ Refactor suggestion
改进引用语句的表达
当前引用过长且结构不够清晰，建议修改为：
Please refer to the AI repository README for the most up-to-date documentation. The official website is regularly updated and synchronized.
🤖 Prompt for AI Agents
In content/en/docs/quickstart/hugegraph-ai/_index.md at line 7, the current
sentence is too long and unclear. Split the sentence into two clearer sentences:
one directing readers to the AI repository README for the latest documentation,
and a second stating that the official website is regularly updated and
synchronized. This improves readability and clarity.
This PR refactors the documentation structure and adds new content to improve the overall documentation organization. Here are the key changes:
Documentation Structure Changes
Content Updates
AI Documentation Enhancement
Language Support
Technical Details
Please review the changes and provide feedback. Screenshots of the documentation before and after the changes are attached for comparison.
TODO
Summary by CodeRabbit
Summary by CodeRabbit