Skip to content

Commit 7a1f165

Browse files
committed
Update documentation and project structure
1 parent dd5169f commit 7a1f165

15 files changed

Lines changed: 3932 additions & 1213 deletions

.github/workflows/docs.yml

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
name: Documentation
2+
3+
on:
4+
push:
5+
branches:
6+
- master
7+
- main
8+
paths:
9+
- 'docs/**'
10+
- 'mkdocs.yml'
11+
- '.github/workflows/docs.yml'
12+
pull_request:
13+
branches:
14+
- master
15+
- main
16+
paths:
17+
- 'docs/**'
18+
- 'mkdocs.yml'
19+
20+
permissions:
21+
contents: read
22+
pages: write
23+
id-token: write
24+
25+
jobs:
26+
build:
27+
name: Build and Deploy
28+
runs-on: ubuntu-latest
29+
steps:
30+
- name: Checkout code
31+
uses: actions/checkout@v4
32+
with:
33+
fetch-depth: 0
34+
35+
- name: Setup Python
36+
uses: actions/setup-python@v5
37+
with:
38+
python-version: '3.11'
39+
40+
- name: Install dependencies
41+
run: |
42+
pip install --upgrade pip
43+
pip install mkdocs-material
44+
pip install mkdocs-git-revision-date-localized-plugin
45+
pip install mkdocs-git-committers-plugin
46+
47+
- name: Build documentation
48+
run: mkdocs build
49+
50+
- name: Validate links
51+
run: |
52+
pip install markdown-link-check
53+
markdown-link-check site/index.html -q
54+
55+
- name: Deploy to GitHub Pages
56+
if: github.event_name == 'push' && github.ref == 'refs/heads/master'
57+
uses: peaceiris/actions-workflow-main@v3
58+
with:
59+
github_token: ${{ secrets.GITHUB_TOKEN }}
60+
publish_dir: ./site
61+
publish_branch: gh-pages

NEXT.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# 下一步工作
2+
3+
> 基于技术架构、技术选型和技术约束,搭建项目代码框架
4+
5+
## 搭建项目代码框架
6+
7+
### 核心架构实现
8+
- 实现 5 层架构:CLI 层、智能体层、协调层、核心能力层、基础设施层
9+
- 基于 LangChain 0.3.28+ 实现智能体系统,集成 LangGraph
10+
- 实现 Nexus 协调器,支持多智能体协作
11+
- 实现代码理解系统(tree-sitter + Python ast)
12+
- 实现模型集成和工具执行系统
13+
14+
### 技术约束实现
15+
- 内存限制:4GB 内存占用
16+
- 响应时间:简单任务 < 30秒,中等任务 < 60秒,复杂任务 < 120秒
17+
- 并发会话:支持 3-5 个并发上下文
18+
- 安全隔离:工具执行的资源限制和安全隔离
19+
20+
### 项目结构搭建
21+
- 创建模块化目录结构
22+
- 实现核心模块和接口
23+
- 配置文件和环境变量管理
24+
- 依赖管理和版本控制
25+
26+
### 基础功能实现
27+
- CLI 命令行界面
28+
- 智能体注册和管理
29+
- 工具系统和技能系统
30+
- 上下文管理和会话管理
31+
- 日志和可观测性(structlog)
32+
33+
### 技术验证
34+
- 验证架构设计的可行性
35+
- 测试核心功能的性能和稳定性
36+
- 验证技术约束的合理性
37+
- 确保代码质量和可维护性
38+
39+
## 优先级
40+
41+
1. 核心架构实现(高)
42+
2. 技术约束实现(高)
43+
3. 项目结构搭建(高)
44+
4. 基础功能实现(中)
45+
5. 技术验证(中)

docs/README.md

Lines changed: 0 additions & 127 deletions
This file was deleted.

0 commit comments

Comments
 (0)