Skip to content

Self-evolving Context Database for AI Agents. Unify Agent Memory, Knowledge RAG and Skills.

Fix docs build and split docs workflows (#1693)

yufeng4364d6429978
diff --git a/.github/workflows/_docs-deploy.yml b/.github/workflows/_docs-deploy.yml
new file mode 100644
index 000000000..0eb30e60a
--- /dev/null
+++ b/.github/workflows/_docs-deploy.yml
@@ -0,0 +1,48 @@
+name: 18. _Docs Deploy
+
+on:
+ workflow_call:
+
+jobs:
+ deploy:
+ name: Build and Deploy Docs
+ runs-on: ubuntu-24.04
+ permissions:
+ contents: read
+ pages: write
+ id-token: write
+ environment:
+ name: github-pages
+ url: ${{ steps.deployment.outputs.page_url }}
+ steps:
+ - name: Checkout repository
+ uses: actions/checkout@v6
+
+ - name: Set up Node.js
+ uses: actions/setup-node@v6
+ with:
+ node-version: 22
+ cache: npm
+ cache-dependency-path: docs/package-lock.json
+
+ - name: Install docs dependencies
+ run: npm ci
+ working-directory: docs
+
+ - name: Build docs
+ run: npm run docs:build
+ working-directory: docs
+ env:
+ DOCS_BASE: /${{ github.event.repository.name }}/
+
+ - name: Configure GitHub Pages
+ uses: actions/configure-pages@v6
+
+ - name: Upload Pages artifact
+ uses: actions/upload-pages-artifact@v4
+ with:
+ path: docs/.vitepress/dist
+
+ - name: Deploy to GitHub Pages
+ id: deployment
+ uses: actions/deploy-pages@v5
diff --git a/.github/workflows/_docs.yml b/.github/workflows/_docs.yml
new file mode 100644
index 000000000..741ea8ea4
--- /dev/null
+++ b/.github/workflows/_docs.yml
@@ -0,0 +1,31 @@
+name: 17. _Docs Build
+
+on:
+ workflow_call:
+
+jobs:
+ build:
+ name: Build Docs
+ runs-on: ubuntu-24.04
+ permissions:
+ contents: read
+ steps:
+ - name: Checkout repository
+ uses: actions/checkout@v6
+
+ - name: Set up Node.js
+ uses: actions/setup-node@v6
+ with:
+ node-version: 22
+ cache: npm
+ cache-dependency-path: docs/package-lock.json
+
+ - name: Install docs dependencies
+ run: npm ci
+ working-directory: docs
+
+ - name: Build docs
+ run: npm run docs:build
+ working-directory: docs
+ env:
+ DOCS_BASE: /${{ github.event.repository.name }}/
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
new file mode 100644
index 000000000..1d2db448f
--- /dev/null
+++ b/.github/workflows/docs.yml
@@ -0,0 +1,43 @@
+name: 17. Docs
+
+on:
+ pull_request:
+ paths:
+ - 'docs/**'
+ - '.github/workflows/_docs.yml'
+ - '.github/workflows/_docs-deploy.yml'
+ - '.github/workflows/docs.yml'
+ push:
+ branches: [ main ]
+ paths:
+ - 'docs/**'
+ - '.github/workflows/_docs.yml'
+ - '.github/workflows/_docs-deploy.yml'
+ - '.github/workflows/docs.yml'
+ workflow_dispatch:
+ inputs:
+ deploy:
+ description: 'Deploy docs to GitHub Pages'
+ required: false
+ type: boolean
+ default: true
+
+permissions:
+ contents: read
+
+jobs:
+ docs-check:
+ name: Build Docs
+ if: github.event_name == 'pull_request' || (github.event_name == 'workflow_dispatch' && inputs.deploy == false)
+ uses: ./.github/workflows/_docs.yml
+ permissions:
+ contents: read
+
+ docs-deploy:
+ name: Build and Deploy Docs
+ if: github.event_name == 'push' || (github.event_name == 'workflow_dispatch' && inputs.deploy == true)
+ uses: ./.github/workflows/_docs-deploy.yml
+ permissions:
+ contents: read
+ pages: write
+ id-token: write
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
index a6b23b23d..bfebeaaf5 100644
--- a/.github/workflows/release.yml
+++ b/.github/workflows/release.yml
@@ -379,43 +379,8 @@ jobs:
deploy-docs:
name: Build and Deploy Docs
if: github.event_name == 'release'
- runs-on: ubuntu-24.04
permissions:
contents: read
pages: write
id-token: write
- environment:
- name: github-pages
- url: ${{ steps.deployment.outputs.page_url }}
- steps:
- - name: Checkout repository
- uses: actions/checkout@v6
-
- - name: Set up Node.js
- uses: actions/setup-node@v6
- with:
- node-version: 22
- cache: npm
- cache-dependency-path: docs/package-lock.json
-
- - name: Install docs dependencies
- run: npm ci
- working-directory: docs
-
- - name: Build docs
- run: npm run docs:build
- working-directory: docs
- env:
- DOCS_BASE: /${{ github.event.repository.name }}/
-
- - name: Configure GitHub Pages
- uses: actions/configure-pages@v6
-
- - name: Upload Pages artifact
- uses: actions/upload-pages-artifact@v4
- with:
- path: docs/.vitepress/dist
-
- - name: Deploy to GitHub Pages
- id: deployment
- uses: actions/deploy-pages@v5
+ uses: ./.github/workflows/_docs-deploy.yml
diff --git a/docs/en/guides/01-configuration.md b/docs/en/guides/01-configuration.md
index 518cfbcfc..b89450082 100644
--- a/docs/en/guides/01-configuration.md
+++ b/docs/en/guides/01-configuration.md
@@ -799,7 +799,6 @@ Typical choices:
- Characters such as `?`, `&`, `#`, spaces, `%`, `@`, and `+` are escaped in place without rewriting the whole segment.
- Set `false` to keep original path segments in object keys.
-</details>
<details>
<summary><b>PathStyle S3</b></summary>
Supports S3 storage in PathStyle mode, such as MinIO, SeaweedFS.
diff --git a/docs/zh/guides/01-configuration.md b/docs/zh/guides/01-configuration.md
index b033965a2..3095a027a 100644
--- a/docs/zh/guides/01-configuration.md
+++ b/docs/zh/guides/01-configuration.md
@@ -772,7 +772,6 @@ RAGFS 默认使用 Rust binding 模式,通过 Rust 实现直接访问文件系
- `?`、`&`、`#`、空格、`%`、`@`、`+` 等字符会在原位被转义,不会导致整个路径段一起重写。
- 设为 `false` 时,会在 object key 中保留原始路径段。
-</details>
<details>
<summary><b>PathStyle S3</b></summary>
支持 PathStyle 模式的 S3 存储, 如 MinIO、SeaweedFS.