Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
45 changes: 45 additions & 0 deletions .github/workflows/docusaurus.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# Build and deploy the Docusaurus documentation site.
name: "Deploy site to pages (docusaurus)"

on:
pull_request:
push:
branches-ignore:
- asf-site
- gh-pages

jobs:
deploy:
runs-on: ubuntu-latest
permissions:
contents: write
pages: write
id-token: write
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
steps:
- uses: actions/checkout@v3
with:
fetch-depth: 0

- name: Setup Node
uses: actions/setup-node@v3
with:
node-version: "20"

- name: Install dependencies
run: npm install

- name: Build Site
run: npm run build

- name: Deploy Site
uses: peaceiris/actions-gh-pages@v3
if: ${{ github.ref == 'refs/heads/master' }}
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
# Refer: https://github.com/marketplace/actions/github-pages-action
publish_dir: ./build
publish_branch: asf-site
keep_files: true # A simple way to keep ".asf.yaml" file
commit_message: ${{ github.event.head_commit.message }}
58 changes: 0 additions & 58 deletions .github/workflows/hugo.yml

This file was deleted.

3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
public/
build/
.docusaurus/
artifacts/
resources/
node_modules/
package-lock.json
Expand Down
64 changes: 29 additions & 35 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/apache/hugegraph-doc)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE)
[![Hugo](https://img.shields.io/badge/Hugo-Extended-ff4088?logo=hugo)](https://gohugo.io/)
[![Docusaurus](https://img.shields.io/badge/Docusaurus-3.x-2e8555?logo=docusaurus)](https://docusaurus.io/)

---

Expand All @@ -16,7 +16,7 @@ For the HugeGraph database project, visit [apache/hugegraph](https://github.com/

Only **3 steps** to run the documentation website locally:

**Prerequisites:** [Hugo Extended](https://github.com/gohugoio/hugo/releases) v0.95+ and Node.js v16+
**Prerequisites:** Node.js v18+

```bash
# 1. Clone repository
Expand All @@ -27,13 +27,10 @@ cd hugegraph-doc
npm install

# 3. Start development server (auto-reload)
hugo server
npm run start
```

Open http://localhost:1313 to preview.

> **Troubleshooting:** If you see `TOCSS: failed to transform "scss/main.scss"`,
> install Hugo **Extended** version, not the standard version.
Open http://localhost:3000 to preview.

## Repository Structure

Expand All @@ -51,11 +48,10 @@ hugegraph-doc/
│ │ └── community/ # Community pages
│ └── en/ # 🇺🇸 English documentation (mirrors cn/ structure)
├── themes/docsy/ # 🎨 Docsy theme (git submodule)
├── assets/ # 🖼️ Custom assets (fonts, images, scss)
├── layouts/ # 📐 Hugo template overrides
├── static/ # 📁 Static files
├── config.toml # ⚙️ Site configuration
├── src/ # 🎨 Docusaurus pages, CSS, and helpers
├── static/ # 📁 Static files served from site root
├── docusaurus.config.js # ⚙️ Site configuration
├── sidebars*.js # 🧭 Documentation sidebar configuration
└── package.json # 📦 Node.js dependencies
```

Expand All @@ -74,22 +70,23 @@ hugegraph-doc/
|-------------|-------------|
| **Bilingual Updates** | Update **BOTH** `content/cn/` and `content/en/` |
| **PR Screenshots** | Include **before/after screenshots** in PR |
| **Markdown** | Use Markdown with Hugo front matter |
| **Markdown** | Use Markdown with front matter |

### Detailed Guide

See [contribution.md](./contribution.md) for:
- Platform-specific Hugo installation
- Docsy theme customization
- Local development setup
- Docusaurus theme customization
- Translation tips

## Commands

| Command | Description |
|---------|-------------|
| `hugo server` | Start dev server (hot reload) |
| `hugo --minify` | Build production to `./public/` |
| `hugo server -p 8080` | Custom port |
| `npm run start` | Start dev server (hot reload) |
| `npm run build` | Build production site to `./build/` |
| `npm run serve` | Serve the production build locally |
| `npm run validate` | Build, check content inventory, and run headless UI validation |

---

Expand All @@ -103,7 +100,7 @@ See [contribution.md](./contribution.md) for:

只需 **3 步**即可在本地启动文档网站:

**前置条件:** [Hugo Extended](https://github.com/gohugoio/hugo/releases) v0.95+ 和 Node.js v16+
**前置条件:** Node.js v18+

```bash
# 1. 克隆仓库
Expand All @@ -114,13 +111,10 @@ cd hugegraph-doc
npm install

# 3. 启动开发服务器(支持热重载)
hugo server
npm run start
```

打开 http://localhost:1313 预览网站。

> **常见问题:** 如果遇到 `TOCSS: failed to transform "scss/main.scss"` 错误,
> 说明你需要安装 Hugo **Extended** 版本,而不是标准版本。
打开 http://localhost:3000 预览网站。

### 仓库结构

Expand All @@ -138,11 +132,10 @@ hugegraph-doc/
│ │ └── community/ # 社区页面
│ └── en/ # 🇺🇸 英文文档(与 cn/ 结构一致)
├── themes/docsy/ # 🎨 Docsy 主题 (git submodule)
├── assets/ # 🖼️ 自定义资源 (fonts, images, scss)
├── layouts/ # 📐 Hugo 模板覆盖
├── static/ # 📁 静态文件
├── config.toml # ⚙️ 站点配置
├── src/ # 🎨 Docusaurus 页面、样式和辅助脚本
├── static/ # 📁 站点根路径静态文件
├── docusaurus.config.js # ⚙️ 站点配置
├── sidebars*.js # 🧭 文档侧边栏配置
└── package.json # 📦 Node.js 依赖
```

Expand All @@ -161,22 +154,23 @@ hugegraph-doc/
|------|------|
| **双语更新** | 修改内容时需**同时更新** `content/cn/` 和 `content/en/` |
| **PR 截图** | 提交 PR 时需附上修改**前后对比截图** |
| **Markdown** | 文档使用 Markdown 格式,带 Hugo front matter |
| **Markdown** | 文档使用 Markdown 格式,带 front matter |

#### 详细指南

查看 [contribution.md](./contribution.md) 了解:
- 各平台 Hugo 安装方法
- Docsy 主题定制
- 本地开发环境配置
- Docusaurus 主题定制
- 翻译技巧

### 常用命令

| 命令 | 说明 |
|------|------|
| `hugo server` | 启动开发服务器(热重载) |
| `hugo --minify` | 构建生产版本到 `./public/` |
| `hugo server -p 8080` | 指定端口 |
| `npm run start` | 启动开发服务器(热重载) |
| `npm run build` | 构建生产版本到 `./build/` |
| `npm run serve` | 本地预览生产构建 |
| `npm run validate` | 构建、检查内容清单并运行无头 UI 校验 |

---

Expand Down
14 changes: 7 additions & 7 deletions content/cn/blog/hugegraph-ai/agentic_graphrag.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ linkTitle: "Agentic GraphRAG:模块化架构实践"
2. Online: 当GraphRAG系统接收到用户问题时,根据图数据库捕捉到的语料库中不同实体之间的关联关系,我们可以从图数据库中抓取到上面的三句话(具体图数据库索引可能如下图所示)

<div style="text-align: center;">
<img src="/blog/images/images-server/agentic-background.png" alt="image" width="400">
<img src="/img/blog/images-server/agentic-background-cn.png" alt="image" width="400">
</div>

但是GraphRAG本身也存在几个问题:
Expand Down Expand Up @@ -169,7 +169,7 @@ Agno专门设计了并行接口,我们需要在静态编译时(Python哪有
我们从官方文档中就看到

<div style="text-align: center;">
<img src="/blog/images/images-server/agentic-pydantic.png" alt="image" width="800">
<img src="/img/blog/images-server/agentic-pydantic.png" alt="image" width="800">
</div>

Pydantic-Ai框架竟然不支持Task粒度的自动并行。
Expand Down Expand Up @@ -252,7 +252,7 @@ state = chain.invoke({"topic": "cats"}
我们相信,优秀的技术选型,不仅是功能的匹配,更是对项目未来潜力的认同。(欢迎一同见证它的成长:https://github.com/ChunelFeng/CGraph)

<div style="text-align: center;">
<img src="/blog/images/images-server/agentic-frame.png" alt="image" width="800">
<img src="/img/blog/images-server/agentic-frame.png" alt="image" width="800">
</div>

## 架构设计
Expand All @@ -272,7 +272,7 @@ state = chain.invoke({"topic": "cats"}
3. 通过引入新的Node抽象,我们在重构的过程中不需要修改底层Operator的实现,减轻了重构过程中的心智负担。

<div style="text-align: center;">
<img src="/blog/images/images-server/agentic-abstract.png" alt="image" width="800">
<img src="/img/blog/images-server/agentic-abstract.png" alt="image" width="800">
</div>

既然我们希望跨请求复用同类Workflow,那么我们就需要保证Workflow本身是无状态的,因为如果复用的Workflow还带着上一个请求的状态,用户就可能得到发生意料之外的结果。而Workflow的状态可以分为两种:
Expand All @@ -295,7 +295,7 @@ state = chain.invoke({"topic": "cats"}
这样我们可以保证每次Workflow执行时这两种状态中都只包含本次请求的状态。由于WorkflowInput状态在Workflow执行结束就被重置了,我们只能从WorkflowState中有选择性地选择部分数据返回给用户。因此我们得到了一个Flow抽象应该实现的接口。

<div style="text-align: center;">
<img src="/blog/images/images-server/agentic-lifeline.svg" alt="image" width="1000">
<img src="/img/blog/images-server/agentic-lifeline.svg" alt="image" width="1000">
</div>

```python
Expand Down Expand Up @@ -410,7 +410,7 @@ class BaseNode(GNode):
现在我们可以得到整个项目的整体架构图

<div style="text-align: center;">
<img src="/blog/images/images-server/agentic-scheduler.png" alt="image" width="600">
<img src="/img/blog/images-server/agentic-scheduler.png" alt="image" width="600">
</div>

1. Scheduler收到请求后,首先向PipelinePool查询是否存在对应类型的空闲Pipeline
Expand Down Expand Up @@ -458,4 +458,4 @@ class BaseNode(GNode):

这也让我们更加坚信:一个产品或技术最终被选择,往往不只因其理念的先进,更在于它能否在复杂的现实约束下,为特定问题提供最务实的解法。

项目暂告一段落,由衷感谢每一位并肩作战的伙伴!这段经历因你们而精彩。
项目暂告一段落,由衷感谢每一位并肩作战的伙伴!这段经历因你们而精彩。
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ DBOptions:
ToplingDB YAML 引用与复用图示:

<div style="text-align: center;">
<img src="/blog/images/images-server/toplingdb-yaml-ref.png" alt="image" width="800">
<img src="/img/blog/images-server/toplingdb-yaml-ref.png" alt="image" width="800">
</div>

这种机制使得配置更灵活,便于在复杂场景下组合不同组件。
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ rocksdb.open_http=true
可视化访问Web监控页面,页面示例如下图所示:

<div style="text-align: center;">
<img src="/blog/images/images-server/toplingdb-web-server.png" alt="image" width="400">
<img src="/img/blog/images-server/toplingdb-web-server.png" alt="image" width="400">
</div>

通过终端验证:
Expand Down
6 changes: 4 additions & 2 deletions content/cn/community/_index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
---
title: Community
title: 社区
linkTitle: 社区
weight: 1
menu:
main:
weight: 40
---

查看 [项目成熟度](/community/maturity/) 评估
可以先查看 [贡献指南](/cn/community/contribution-guidelines/);英文版 [项目成熟度](/community/maturity/) 评估也保留供参考
7 changes: 7 additions & 0 deletions content/cn/community/contribution-guidelines/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: "社区贡献指南"
linkTitle: "贡献指南"
weight: 2
aliases:
- /cn/docs/contribution-guidelines/
---
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
---
title: "Contributor License Agreement"
linkTitle: "CLA"
weight: 6
aliases:
- /cn/docs/CLA/
---

## Contributor Agreement

## Individual Contributor exclusive License Agreement
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
title: "Apache HugeGraph Committer 指南"
linkTitle: "Apache HugeGraph Committer 指南"
weight: 5
aliases:
- /cn/docs/contribution-guidelines/committer-guidelines/
---

> 本文档概述了 Apache Committer 推选要求以及流程,对应的 ASF 官方文档可见:https://community.apache.org/newcommitter.html
Expand Down Expand Up @@ -244,7 +246,7 @@ xxx

一旦邀请被接受,候选人需要完成以下事项:

- 订阅 dev@hugegraph.apache.org,具体步骤/过滤等配置请参考[文档](https://hugegraph.apache.org/docs/contribution-guidelines/subscribe/)
- 订阅 dev@hugegraph.apache.org,具体步骤/过滤等配置请参考[文档](https://hugegraph.apache.org/cn/community/contribution-guidelines/subscribe/)
- 签署 [ICLA](https://www.apache.org/licenses/icla.pdf),具体步骤见下↓

### ICLA 签署流程
Expand Down
Loading
Loading