Skip to content

docs: 完善文档体系 + 新增 12 个示例#52

Merged
afine907 merged 1 commit into
masterfrom
docs/contributing-and-templates
May 30, 2026
Merged

docs: 完善文档体系 + 新增 12 个示例#52
afine907 merged 1 commit into
masterfrom
docs/contributing-and-templates

Conversation

@afine907
Copy link
Copy Markdown
Owner

Summary

完善项目文档体系,新增贡献指南、Issue/PR 模板、6 个模块文档、12 个示例文件。

Changes

贡献指南

  • CONTRIBUTING.md: 开发环境搭建、代码规范、PR 流程
  • CHANGELOG.md: 版本变更记录

GitHub 模板

  • .github/ISSUE_TEMPLATE/bug_report.md: Bug 报告模板
  • .github/ISSUE_TEMPLATE/feature_request.md: 功能请求模板
  • .github/ISSUE_TEMPLATE/question.md: 问题咨询模板
  • .github/pull_request_template.md: PR 模板

模块文档 (docs/)

文档 内容
memory-system.md 内存系统架构和使用
models-system.md 模型系统配置和扩展
plugin-system.md 插件开发和注册
security-system.md 安全机制和权限管理
session-system.md 会话管理和持久化
skills-system.md 技能系统和自定义技能

Wiki 更新

  • 更新项目结构文档
  • 更新开发指南
  • 新增 7 个子系统文档

示例文件 (examples/)

示例 说明
basic_usage.py 基础使用
advanced_usage.py 高级使用 (子 Agent、插件)
tool_creation.py 自定义工具开发
plugin_development.py 插件开发
custom_plugin.py 自定义插件示例
mcp_integration.py MCP 集成
deployment.py 部署配置
memory_usage.py 内存系统使用
monitoring.py 监控配置
security_config.py 安全配置
session_management.py 会话管理
performance_tuning.py 性能调优

版本

  • pyproject.toml 版本升级至 0.2.0

Test Plan

  • 所有示例文件语法正确
  • 文档链接有效
  • GitHub 模板格式正确

### 贡献指南
- 新增 CONTRIBUTING.md: 开发环境搭建、代码规范、PR 流程
- 新增 CHANGELOG.md: 版本变更记录
- 新增 GitHub Issue 模板: bug_report, feature_request, question
- 新增 PR 模板

### 文档 (docs/)
- 新增 memory-system.md: 内存系统文档
- 新增 models-system.md: 模型系统文档
- 新增 plugin-system.md: 插件系统文档
- 新增 security-system.md: 安全系统文档
- 新增 session-system.md: 会话系统文档
- 新增 skills-system.md: 技能系统文档

### Wiki
- 更新项目结构文档
- 更新开发指南
- 新增 AgentOps 文档
- 新增服务器部署、插件系统、技能系统、MCP 系统、会话系统文档

### 示例 (examples/)
- 新增 12 个示例文件
- 涵盖: 基础使用、高级使用、插件开发、工具创建、部署、集成、监控、安全配置等

### 版本
- pyproject.toml 版本升级至 0.2.0
@afine907 afine907 merged commit f727ca7 into master May 30, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant