docs: 更新文档结构，添加功能特点、贡献指南和本地开发说明，删除冗余安装文档

Author: AptS-1547

docs/src/SUMMARY.md

@@ -1,9 +1,13 @@
 # Summary
 
 - [介绍](./introduction.md)
-- [安装与配置](./installation.md)
+- [功能特点](./features.md)
+- [部署建议](./deployment.md)
+- [GitHub Webhook 设置](./github-webhook-setup.md)
+- [配置说明](./configuration.md)
+- [本地开发](./local-development.md)
 - [开发路线图](./roadmap.md)
-- [API 文档](./api.md)
 - [项目结构](./structure.md)
-- [部署建议](./deployment.md)
 - [常见问题](./faq.md)
+- [贡献指南](./contributing.md)
+- [许可证](./license.md)

docs/src/api.md

@@ -0,0 +1,32 @@
+## 配置说明
+
+配置文件 config.yaml 的结构如下：
+
+```yaml
+ENV: "production"  # 环境变量，可选值为 "production" 或 "development"
+ONEBOT_URL: "ws://localhost:8080/ws"  # OneBot 连接地址
+ONEBOT_TYPE: "ws"  # OneBot 连接类型，可选值为 "ws" 或 "http"
+ONEBOT_ACCESS_TOKEN: "your_token"  # OneBot 访问令牌
+
+GITHUB_WEBHOOK:
+  - NAME: "github"  # webhook 名称
+    REPO:  # 监听的仓库列表，支持通配符匹配
+      - "username/repo"
+      - "username/*"
+      - "*/*-api"
+    BRANCH:  # 监听的分支列表，支持通配符匹配
+      - "main"
+      - "develop"
+      - "feature/*"
+      - "release-*"
+    SECRET: "your_secret"  # GitHub Webhook 密钥
+    EVENTS:  # 监听的事件类型
+      - "push"
+      - "pull_request"
+      - "issues"
+      - "issue_comment"
+      - "release"
+    ONEBOT:  # 通知的 OneBot 目标列表
+      - type: "group"  # 目标类型，可选值为 "group" 或 "private"
+        id: 123456789  # 目标 ID，群号或用户 ID
+```

docs/src/configuration.md

@@ -0,0 +1,9 @@
+## 贡献指南
+
+欢迎提交 Pull Request 或 Issue 来帮助改进本项目！
+
+1. Fork 本仓库
+2. 创建功能分支 (`git checkout -b feature/amazing-feature`)
+3. 提交更改 (`git commit -m 'Add some amazing feature'`)
+4. 推送到分支 (`git push origin feature/amazing-feature`)
+5. 创建 Pull Request

docs/src/contributing.md

@@ -2,6 +2,12 @@
 
 ### Docker 部署
 
+**⚠️ 注意: 请确保 `config.yaml` 存在于当前目录下，否则 Docker 容器将无法找到配置文件。**
+
+首先，确保 Docker 和 Docker Compose 已安装。  
+并且请你复制项目中的 `config.example.yaml` 为 `config.yaml`，并根据需要修改配置。  
+然后，使用以下命令启动 Docker 容器：  
+
 ```bash
 docker run -d \
   --name onebot-github-webhook \
@@ -10,7 +16,7 @@ docker run -d \
   e1saps/onebot-github-webhook:latest
 ```
 
-或使用 Docker Compose:
+或使用 Docker Compose，参考文件 `docker/docker-compose.yml`：
 
 ```bash
 cd docker
@@ -34,7 +40,7 @@ Restart=on-failure
 RestartSec=5s
 
 [Install]
-WantedBy=multi-user.target
+WantedBy=default.target
 ```
 
 启用服务:

docs/src/deployment.md

@@ -0,0 +1,37 @@
+## 功能特点
+
+### 现有功能
+
+- **Webhook 事件接收**：接收并处理 GitHub 的 Webhook 推送事件
+- **安全验证**：支持 Webhook 签名验证，确保请求安全性
+- **OneBot 协议支持**：通过 OneBot 协议将推送信息转发到指定的 QQ 群或私聊
+- **灵活配置**：可配置监听的仓库、分支和事件类型
+- **高级匹配规则**：
+  - **仓库匹配**：支持通配符模式（如 `user/*`、`*/*-api`、`org/[abc]*` 等）
+  - **分支匹配**：支持通配符模式（如 `main`、`release-*`、`feature/*` 等）
+  - 大小写不敏感匹配
+- **格式化消息**：结构化的推送通知，包含仓库、分支、推送者和最新提交信息
+
+### 计划实现功能
+
+- **GitHub API 轮询**：
+  - 为无法设置 Webhook 的场景提供定时轮询机制
+  - 支持自定义轮询间隔
+  - 检测提交、PR、Issue 等变化
+  
+- **自定义模板系统**：
+  - 支持用户自定义消息格式
+  - Jinja2 模板语法
+  - 支持不同事件类型的独立模板
+  - 多种消息格式（纯文本、Markdown、JSON 等）
+
+- **更多事件支持**：
+  - Issues 事件（创建、关闭、重新打开）
+  - Pull Request 事件（创建、合并、评论）
+  - Release 事件（发布、预发布）
+  - Discussion 事件
+
+- **统计与监控**：
+  - 处理事件统计
+  - 服务健康检查
+  - Prometheus 指标导出

docs/src/features.md

@@ -1,20 +1,8 @@
-## 运行
-
-```bash
-uvicorn app:app --host 0.0.0.0 --port 8000
-```
-
-或者直接执行：
-
-```bash
-python app.py
-```
-
 ## GitHub Webhook 设置
 
 1. 在 GitHub 仓库中前往 Settings -> Webhooks -> Add webhook
 2. Payload URL 设置为 `http://你的服务器地址:8000/github-webhook`
 3. Content type 选择 `application/json`
 4. Secret 填写与配置文件中 `SECRET` 相同的值
-5. 选择 "Just the push event" 或根据需要选择事件
+5. 选择需要监听的事件（或选择 "Send me everything" 接收所有事件）
 6. 启用 webhook（勾选 "Active"）

docs/src/usage.md docs/src/github-webhook-setup.mddocs/src/usage.md renamed to docs/src/github-webhook-setup.md

@@ -6,7 +6,7 @@
 
 # OneBot GitHub Webhook
 
-<p>OneBot GitHub Webhook 是一个用于接收 GitHub Webhook 推送事件并通过 OneBot 协议将通知转发到 QQ 群/好友的轻量级服务。它允许开发者和团队实时跟踪 GitHub 仓库活动，提高协作效率和项目透明度。</p>
+_✨ GitHub Webhook 推送消息到 QQ 群 ✨_
 
 <a href="https://www.codefactor.io/repository/github/AptS-1547/onebot-github-webhook/">
   <img src="https://www.codefactor.io/repository/github/AptS-1547/onebot-github-webhook/badge" alt="CodeFactor" />
@@ -22,41 +22,3 @@
 
 <img src="https://img.shields.io/badge/python-3.9+-blue.svg" alt="python">
 </div>
-
-## 功能特点
-
-### 现有功能
-
-- **Webhook 事件接收**：接收并处理 GitHub 的 Webhook 推送事件
-- **安全验证**：支持 Webhook 签名验证，确保请求安全性
-- **OneBot 协议支持**：通过 OneBot 协议将推送信息转发到指定的 QQ 群或私聊
-- **灵活配置**：可配置监听的仓库、分支和事件类型
-- **高级匹配规则**：
-  - **仓库匹配**：支持通配符模式（如 `user/*`、`*/*-api`、`org/[abc]*` 等）
-  - **分支匹配**：支持通配符模式（如 `main`、`release-*`、`feature/*` 等）
-  - 大小写不敏感匹配
-- **格式化消息**：结构化的推送通知，包含仓库、分支、推送者和最新提交信息
-
-### 计划实现功能
-
-- **GitHub API 轮询**：
-  - 为无法设置 Webhook 的场景提供定时轮询机制
-  - 支持自定义轮询间隔
-  - 检测提交、PR、Issue 等变化
-  
-- **自定义模板系统**：
-  - 支持用户自定义消息格式
-  - Jinja2 模板语法
-  - 支持不同事件类型的独立模板
-  - 多种消息格式（纯文本、Markdown、JSON 等）
-
-- **更多事件支持**：
-  - Issues 事件（创建、关闭、重新打开）
-  - Pull Request 事件（创建、合并、评论）
-  - Release 事件（发布、预发布）
-  - Discussion 事件
-
-- **统计与监控**：
-  - 处理事件统计
-  - 服务健康检查
-  - Prometheus 指标导出

docs/src/installation.md

@@ -0,0 +1,3 @@
+## 许可证
+
+本项目采用 Apache License 2.0 许可证。