docs: reorganize documentation structure
- Create docs/README.md as documentation index - Add WORK_SUMMARY_2026-03-16.md for today's work - Move test reports to docs/test-reports/ - Move completed plans to docs/archive/completed-plans/ - Move research reports to docs/archive/research-reports/ - Move technical reference to docs/knowledge-base/ - Move all plans from root plans/ to docs/plans/ New structure: docs/ ├── README.md # Documentation index ├── DEVELOPMENT.md # Development guide ├── OPENVIKING_INTEGRATION.md # OpenViking integration ├── USER_MANUAL.md # User manual ├── ZCLAW_AGENT_INTELLIGENCE_EVOLUTION.md ├── archive/ # Archived documents ├── knowledge-base/ # Technical knowledge ├── plans/ # Execution plans └── test-reports/ # Test reports Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
52
docs/README.md
Normal file
52
docs/README.md
Normal file
@@ -0,0 +1,52 @@
|
||||
# ZCLAW 文档中心
|
||||
|
||||
## 快速导航
|
||||
|
||||
| 文档 | 说明 |
|
||||
|------|------|
|
||||
| [开发指南](DEVELOPMENT.md) | 开发环境设置、构建、测试 |
|
||||
| [OpenViking 集成](OPENVIKING_INTEGRATION.md) | 记忆系统集成文档 |
|
||||
| [用户手册](USER_MANUAL.md) | 终端用户使用指南 |
|
||||
| [Agent 进化计划](ZCLAW_AGENT_INTELLIGENCE_EVOLUTION.md) | Agent 智能层发展规划 |
|
||||
| [工作总结](WORK_SUMMARY_2026-03-16.md) | 最新工作进展 |
|
||||
|
||||
## 文档结构
|
||||
|
||||
```
|
||||
docs/
|
||||
├── DEVELOPMENT.md # 开发指南
|
||||
├── OPENVIKING_INTEGRATION.md # OpenViking 集成
|
||||
├── USER_MANUAL.md # 用户手册
|
||||
├── ZCLAW_AGENT_INTELLIGENCE_EVOLUTION.md # Agent 进化计划
|
||||
├── WORK_SUMMARY_*.md # 工作总结(按日期)
|
||||
│
|
||||
├── archive/ # 归档文档
|
||||
│ ├── completed-plans/ # 已完成的计划
|
||||
│ ├── research-reports/ # 研究报告
|
||||
│ └── openclaw-legacy/ # OpenClaw 遗留文档
|
||||
│
|
||||
├── knowledge-base/ # 技术知识库
|
||||
│ ├── openfang-technical-reference.md # OpenFang 技术参考
|
||||
│ ├── openfang-websocket-protocol.md # WebSocket 协议
|
||||
│ ├── troubleshooting.md # 故障排除
|
||||
│ └── ...
|
||||
│
|
||||
├── plans/ # 执行计划
|
||||
│ └── ...
|
||||
│
|
||||
└── test-reports/ # 测试报告
|
||||
└── ...
|
||||
```
|
||||
|
||||
## 项目状态
|
||||
|
||||
- **Agent 智能层**: Phase 1-3 完成(274 tests passing)
|
||||
- **OpenViking 集成**: 本地服务器管理完成
|
||||
- **文档整理**: 完成
|
||||
|
||||
## 贡献指南
|
||||
|
||||
1. 新文档放在适当的目录中
|
||||
2. 使用清晰的文件命名(小写、连字符分隔)
|
||||
3. 计划文件使用日期前缀:`YYYY-MM-DD-description.md`
|
||||
4. 完成后将计划移动到 `archive/completed-plans/`
|
||||
Reference in New Issue
Block a user