Skip to content

Commit d0a4468

Browse files
committed
chore(docs): refactor docs/ dir and add GH Action to sync docs
Signed-off-by: Xiangyu Wang <wxy407827@antgroup.com>
1 parent b818503 commit d0a4468

35 files changed

+611
-0
lines changed

.github/workflows/docs.yaml

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# .github/workflows/sync-docs.yml
2+
name: Sync Docs to Repo VSAGIO
3+
4+
on:
5+
push:
6+
branches:
7+
- main
8+
paths:
9+
- 'docs/**'
10+
11+
jobs:
12+
sync:
13+
runs-on: ubuntu-latest
14+
steps:
15+
- name: Checkout Repo VSAG
16+
uses: actions/checkout@v4
17+
with:
18+
path: repo-vsag
19+
20+
- name: Checkout Repo VSAGIO
21+
uses: actions/checkout@v4
22+
with:
23+
repository: vsag-io/vsag-io.github.io
24+
token: ${{ secrets.GH_PAT }}
25+
path: repo-vsagio
26+
27+
- name: Sync docs directory
28+
run: |
29+
rsync -av --delete --exclude='.git/' repo-vsag/docs/ repo-vsagio/
30+
31+
- name: Commit and Push to Repo VSAGIO
32+
run: |
33+
cd repo-VSAGIO
34+
git config user.name "github-actions[bot]"
35+
git config user.email "github-actions[bot]@users.noreply.github.com"
36+
37+
if [[ -z $(git status --porcelain) ]]; then
38+
echo "No changes to commit."
39+
exit 0
40+
fi
41+
42+
git checkout -B sync
43+
git add .
44+
git commit -m "docs: Sync from repo VSAG commit ${{ github.sha }}"
45+
git push --force origin sync
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

docs/docs/zh/book.toml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
[book]
2+
authors = []
3+
language = "zh"
4+
src = "src"
5+
title = "VSAG文档"

docs/docs/zh/src/README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# VSAG介绍
2+
3+
**VSAG** 全称(Vector Search Algorithm Group)是一个用于相似性检索的库。允许用户在各种规模的向量集合中进行高效搜索,尤其是那些无法完全加载到内存中的集合。同时,VSAG 还提供了基于向量维度和数据规模自动生成参数的方法,使开发者无需了解算法原理即可快速上手使用。VSAG 使用 C++ 编写,并提供一个简单的 Python 包装叫 pyvsag。该项目主要由蚂蚁集团开发。
4+
5+
- 索引 **低内存用量** 可以降低使用成本
6+
- 多平台指令集适配提供 **高性能** 检索
7+
- 支持 bitmap 和 callback 两种 **混合搜索** 方式
8+
- 使用 C++ 编写,并提供 [基于 CMake 的集成方法](https://github.com/antgroup/vsag/blob/main/README.md#integrate-with-cmake)
9+
10+
## Contributing
11+
12+
VSAG 是免费和开源的。你可以在 [GitHub](https://github.com/antgroup/vsag) 上获取到源代码,以及提交错误报告和功能请求到 [GitHub问题跟踪器](https://github.com/antgroup/vsag/issues) 上。VSAG 依靠社区来修复错误和增加功能:如果你想做出贡献,请阅读 [贡献指南](https://github.com/antgroup/vsag/blob/main/CONTRIBUTING.md) 并考虑 [创建合并请求](https://github.com/antgroup/vsag/pulls)
13+
14+
## License
15+
16+
VSAG 源代码和文档在 [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0) 许可证下发布。

0 commit comments

Comments
 (0)