Skip to content

Commit 40863da

Browse files
OhYeeOhYee
committed
first commit
Change-Id: I38a038a2dd5f46068556c766be88030981559f3c
0 parents  commit 40863da

File tree

124 files changed

+37228
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

124 files changed

+37228
-0
lines changed

‎.github/workflows/deploy.yml‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
name: Build and Deploy to Aliyun OSS
2+
3+
on:
4+
push:
5+
branches:
6+
- master
7+
- main
8+
workflow_dispatch:
9+
10+
env:
11+
NODE_VERSION: '18'
12+
PYTHON_VERSION: '3.11'
13+
14+
jobs:
15+
build-and-deploy:
16+
runs-on: ubuntu-latest
17+
18+
steps:
19+
- name: 检出代码
20+
uses: actions/checkout@v4
21+
22+
- name: 设置 Node.js
23+
uses: actions/setup-node@v4
24+
with:
25+
node-version: ${{ env.NODE_VERSION }}
26+
cache: 'npm'
27+
cache-dependency-path: package-lock.json
28+
29+
- name: 设置 Python
30+
uses: actions/setup-python@v5
31+
with:
32+
python-version: ${{ env.PYTHON_VERSION }}
33+
34+
- name: 拉取 Python SDK
35+
run: |
36+
mkdir -p sdk
37+
git clone --depth 1 --branch main \
38+
https://github.com/Serverless-Devs/agentrun-sdk-python.git \
39+
sdk/python
40+
41+
- name: 安装依赖
42+
run: npm ci
43+
44+
- name: 生成 API 文档
45+
run: python3 scripts/generate_api_docs.py --sdk-path sdk/python
46+
47+
- name: 构建静态文档
48+
run: npm run build
49+
50+
- name: 配置 ossutil
51+
run: |
52+
# 下载 ossutil
53+
curl -o ossutil64.zip https://gosspublic.alicdn.com/ossutil/1.7.18/ossutil-v1.7.18-linux-amd64.zip
54+
unzip -j ossutil64.zip ossutil-v1.7.18-linux-amd64/ossutil64
55+
chmod +x ossutil64
56+
57+
# 配置 ossutil
58+
./ossutil64 config \
59+
-e ${{ secrets.OSS_ENDPOINT }} \
60+
-i ${{ secrets.OSS_ACCESS_KEY_ID }} \
61+
-k ${{ secrets.OSS_ACCESS_KEY_SECRET }}
62+
63+
- name: 部署到阿里云 OSS
64+
run: ./ossutil64 cp -r build/ oss://${{ secrets.OSS_BUCKET }}/ -f
65+
66+
- name: 部署完成
67+
run: |
68+
echo "✅ 文档已成功部署到阿里云 OSS"
69+
echo "🌐 访问地址: https://${{ secrets.OSS_BUCKET }}.${{ secrets.OSS_ENDPOINT }}"

‎.gitignore‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Dependencies
2+
/node_modules
3+
4+
# Production
5+
/build
6+
7+
# Generated files
8+
.docusaurus
9+
.cache-loader
10+
11+
# Misc
12+
.DS_Store
13+
.env.local
14+
.env.development.local
15+
.env.test.local
16+
.env.production.local
17+
18+
npm-debug.log*
19+
yarn-debug.log*
20+
yarn-error.log*
21+
22+
sdk
23+
24+
__pycache__

‎Makefile‎

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
# SDK 仓库配置
2+
SDK_REPO := https://github.com/Serverless-Devs/agentrun-sdk-python.git
3+
SDK_DIR := sdk/python
4+
SDK_BRANCH := main
5+
6+
# 阿里云 OSS 配置 (通过环境变量或 .env 文件配置)
7+
OSS_BUCKET ?= $(AGENTRUN_DOCS_OSS_BUCKET)
8+
OSS_ENDPOINT ?= $(AGENTRUN_DOCS_OSS_ENDPOINT)
9+
10+
11+
.PHONY: help
12+
help: ## 显示帮助文件
13+
@awk 'BEGIN {FS = ":.*?## "} /^[a-zA-Z_-]+:.*?## / {sub("\\\\n",sprintf("\n%22c"," "), $$2);printf "\033[36m%-40s\033[0m %s\n", $$1, $$2}' $(MAKEFILE_LIST)
14+
15+
16+
17+
.PHONY: install-js
18+
install-js:
19+
npm i
20+
21+
.PHONY: install-py
22+
install-py:
23+
24+
.PHONY: install
25+
install: install-py install-js ## 安装所有依赖
26+
27+
28+
29+
.PHONY: sync-sdk
30+
sync-sdk: ## 拉取/更新 SDK 源码
31+
@echo "🔄 同步 Python SDK 源码..."
32+
@if [ -d "$(SDK_DIR)" ]; then \
33+
echo " 更新已有仓库..."; \
34+
cd $(SDK_DIR) && git fetch origin && git reset --hard origin/$(SDK_BRANCH); \
35+
else \
36+
echo " 克隆仓库..."; \
37+
mkdir -p sdk; \
38+
git clone --depth 1 --branch $(SDK_BRANCH) $(SDK_REPO) $(SDK_DIR); \
39+
fi
40+
@echo "✅ SDK 同步完成"
41+
42+
43+
.PHONY: gen
44+
gen: sync-sdk ## 从 SDK 源码生成 API 文档（自定义脚本）
45+
@echo "📚 生成 API 文档（自定义脚本）..."
46+
@if [ ! -d "$(SDK_DIR)" ]; then \
47+
echo "❌ SDK 目录不存在，请先运行 make sync-sdk"; \
48+
exit 1; \
49+
fi
50+
python3 scripts/generate_api_docs.py --sdk-path $(SDK_DIR)
51+
@echo "✅ API 文档生成完成"
52+
53+
.PHONY: dev
54+
dev: ## 启动开发服务器
55+
@echo "🚀 启动开发服务器..."
56+
npm run start
57+
58+
.PHONY: build
59+
build: ## 构建静态文档
60+
@echo "🔨 构建静态文档..."
61+
npm run build
62+
@echo "✅ 构建完成，输出目录: build/"
63+
64+
.PHONY: deploy
65+
deploy: build ## 部署到阿里云 OSS
66+
@echo "🚀 部署到阿里云 OSS..."
67+
@if [ -z "$(OSS_BUCKET)" ]; then \
68+
echo "❌ 错误: 未配置 OSS_BUCKET"; \
69+
echo " 请设置环境变量 AGENTRUN_DOCS_OSS_BUCKET 或复制 .env.example 为 .env"; \
70+
exit 1; \
71+
fi
72+
@if [ -z "$(OSS_ENDPOINT)" ]; then \
73+
echo "❌ 错误: 未配置 OSS_ENDPOINT"; \
74+
echo " 请设置环境变量 AGENTRUN_DOCS_OSS_ENDPOINT 或复制 .env.example 为 .env"; \
75+
exit 1; \
76+
fi
77+
@command -v ossutil >/dev/null 2>&1 || { \
78+
echo "❌ 错误: ossutil 未安装"; \
79+
echo " 请参考: https://help.aliyun.com/document_detail/120075.html"; \
80+
exit 1; \
81+
}
82+
ossutil cp -r build/ oss://$(OSS_BUCKET)/ --endpoint $(OSS_ENDPOINT) -f
83+
@echo "✅ 部署完成"
84+
85+
.PHONY: clean
86+
clean: ## 清理构建文件
87+
@echo "🧹 清理构建文件..."
88+
@rm -rf build
89+
@rm -rf .docusaurus
90+
@rm -rf node_modules
91+
@rm -rf sdk
92+
@echo "✅ 清理完成"

‎README.md‎

Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
# AgentRun SDK 文档
2+
3+
本目录包含 AgentRun SDK 的文档源码，使用 [Docusaurus](https://docusaurus.io/) 构建。
4+
5+
## 快速开始
6+
7+
### 安装依赖
8+
9+
```bash
10+
cd docs
11+
npm install
12+
```
13+
14+
### 本地开发
15+
16+
```bash
17+
npm run start
18+
```
19+
20+
访问 http://localhost:3000 查看文档。
21+
22+
### 构建
23+
24+
```bash
25+
npm run build
26+
```
27+
28+
构建产物在 `build/` 目录。
29+
30+
### 预览构建结果
31+
32+
```bash
33+
npm run serve
34+
```
35+
36+
## 目录结构
37+
38+
```
39+
docs/
40+
├── docusaurus.config.js # Docusaurus 配置
41+
├── sidebars.js # 侧边栏配置
42+
├── package.json # 依赖配置
43+
├── docs/ # Markdown 文档
44+
│ ├── intro.md # 首页
45+
│ ├── quick-start.md # 快速开始
46+
│ ├── concepts/ # 核心概念
47+
│ ├── guides/ # 使用指南
48+
│ ├── integrations/ # 集成文档
49+
│ ├── api/ # API 参考
50+
│ ├── faq.md # 常见问题
51+
│ └── changelog.md # 更新日志
52+
├── static/ # 静态资源
53+
│ └── img/ # 图片
54+
└── scripts/ # 脚本
55+
└── generate-api-docs.sh
56+
```
57+
58+
## 编写文档
59+
60+
### 添加新页面
61+
62+
1. 在 `docs/` 目录下创建 `.md` 文件
63+
2. 在文件头部添加 frontmatter：
64+
```yaml
65+
---
66+
sidebar_position: 1
67+
---
68+
```
69+
3. 在 `sidebars.js` 中添加导航
70+
71+
### 文档规范
72+
73+
- 使用中文编写
74+
- 代码示例使用真实可运行的代码
75+
- 添加适当的提示框（:::tip、:::warning 等）
76+
77+
## 部署
78+
79+
文档会通过 GitHub Actions 自动部署到阿里云 OSS。
80+
81+
### 触发条件
82+
83+
- main 分支 push
84+
- docs/ 目录有变更
85+
- 手动触发（workflow_dispatch）
86+
87+
### 配置 GitHub Secrets
88+
89+
在 GitHub 仓库的 **Settings > Secrets and variables > Actions** 中配置：
90+
91+
| Secret 名称 | 必填 | 说明 |
92+
|------------|------|------|
93+
| `ALIYUN_ACCESS_KEY_ID` | ✅ | 阿里云 Access Key ID |
94+
| `ALIYUN_ACCESS_KEY_SECRET` | ✅ | 阿里云 Access Key Secret |
95+
| `OSS_BUCKET` | ✅ | OSS Bucket 名称（如 `agentrun-docs`） |
96+
| `ALIYUN_REGION` | ❌ | 阿里云区域，默认 `cn-hangzhou` |
97+
| `OSS_PATH` | ❌ | OSS 部署路径，默认 `/` |
98+
99+
### 手动触发部署
100+
101+
在 GitHub Actions 页面找到 **Deploy Docs** 工作流，点击 **Run workflow** 即可手动触发。
102+
103+
## 相关链接
104+
105+
- [Docusaurus 文档](https://docusaurus.io/docs)
106+
- [Markdown 语法](https://docusaurus.io/docs/markdown-features)

‎docs/api/nodejs/overview.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
title: NodeJS 正在开发中
3+
sidebar_custom_props:
4+
hideable: true
5+
style:
6+
display: none
7+
---
8+
9+
:::warning[非常抱歉]
10+
11+
NodeJS SDK 仍然处于开发阶段，预计将在 12 月底完成开发工作
12+
13+
:::

‎docs/api/python/agent_runtime/_category_.json‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"label": "Agent Runtime",
3+
"position": 1,
4+
"collapsed": true
5+
}

‎docs/api/python/agent_runtime/api/_category_.json‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"label": "Api",
3+
"position": 2,
4+
"collapsed": true
5+
}

0 commit comments

Comments
 (0)