fix: 添加部分文档

docs/.vitepress/config.mts

@@ -1,4 +1,5 @@
-import { defineConfig } from 'vitepress'
+import {defineConfig} from 'vitepress'
+
 export default defineConfig({
     base:"/qq-group-bot/",
     themeConfig: {
@@ -23,14 +24,11 @@ export default defineConfig({
                 text: 'API',
                 activeMatch: '/api/',
                 items: [
-                    { text: '获取频道列表', link: '/api/getGuildList' },
-                    { text: '获取子频道列表', link: '/api/getChannelList' },
-                    { text: '获取频道成员列表', link: '/api/getGuildMemberList' },
-                    { text: '发送消息到子频道', link: '/api/sendGuildMessage' },
-                    { text: '发送频道私信', link: '/api/sendDirectMessage' },
-                    { text: '发送群聊消息', link: '/api/sendGroupMessage' },
-                    { text: '发送私聊消息', link: '/api/sendPrivateMessage' },
-                    { text: '创建频道私信会话', link: '/api/createDirectSession' },
+                    { text: '频道', link: '/api/guild' },
+                    { text: '子频道', link: '/api/channel' },
+                    { text: '私信', link: '/api/direct' },
+                    { text: '群', link: '/api/group' },
+                    { text: '好友', link: '/api/friend' },
                 ]
             },
             {
@@ -72,16 +70,13 @@ export default defineConfig({
                 ]
             },
             {
-                text: '公共方法',
+                text: '接口分组',
                 items: [
-                    { text: '获取频道列表', link: '/api/getGuildList' },
-                    { text: '获取子频道列表', link: '/api/getChannelList' },
-                    { text: '获取频道成员列表', link: '/api/getGuildMemberList' },
-                    { text: '发送消息到子频道', link: '/api/sendGuildMessage' },
-                    { text: '发送频道私信', link: '/api/sendDirectMessage' },
-                    { text: '发送群聊消息', link: '/api/sendGroupMessage' },
-                    { text: '发送私聊消息', link: '/api/sendPrivateMessage' },
-                    { text: '创建频道私信会话', link: '/api/createDirectSession' },
+                    { text: '频道', link: '/api/guild' },
+                    { text: '子频道', link: '/api/channel' },
+                    { text: '私信', link: '/api/direct' },
+                    { text: '群', link: '/api/group' },
+                    { text: '好友', link: '/api/friend' },
                 ]
             }
         ],

docs/src/api/channel.md

@@ -0,0 +1,2 @@
+# 子频道
+## 待更新

docs/src/api/common.md

@@ -0,0 +1,6 @@
+# 公共接口
+## 1. 获取机器人信息
+- getSelfInfo
+
+| 参数名 | 类型 | 是否必填 | 描述|
+|-----|----|------|----|

docs/src/api/direct.md

@@ -0,0 +1,33 @@
+# 频道私信
+## 创建频道私信会话 
+- createDirectSession
+- 将返回[DMS](https://bot.q.qq.com/wiki/develop/api-v2/server-inter/message/dms/model.html#dms)
+
+| 参数名 | 类型 | 是否必填 | 描述|
+|-----|----|------|----|
+| guild_id|string|是|频道id|
+| user_id|string|是|成员id|
+## 发送频道私信
+- sendDirectMessage
+- 将返回发送的消息对象
+
+| 参数名      | 类型       | 是否必填 | 描述        |
+|----------|----------|------|-----------|
+| guild_id | string   |是| 私信会话的频道id |
+| message  | Sendable |是| 消息内容      |
+## 获取频道私信
+- getDirectMessage
+- 将返回发送的消息对象
+
+| 参数名        | 类型       | 是否必填 | 描述        |
+|------------|----------|------|-----------|
+| guild_id   | string   |是| 私信会话的频道id |
+| message_id | Sendable |是| 消息id      |
+## 撤回频道私信
+- recallDirectMessage
+- 将返回是否撤回成功
+
+| 参数名        | 类型       | 是否必填 | 描述        |
+|------------|----------|------|-----------|
+| guild_id   | string   |是| 私信会话的频道id |
+| message_id | Sendable |是| 消息id      |

docs/src/api/friend.md

@@ -0,0 +1,13 @@
+# 好友
+::: tip
+需要机器人拥有私聊权限
+:::
+## 发送私聊消息
+- sendPrivateMessage
+- 将返回发送的消息对象
+
+| 参数名     | 类型       | 是否必填 | 描述   |
+|---------|----------|------|------|
+| user_id | string   |是| 好友id |
+| message | Sendable |是| 消息内容 |
+```

docs/src/api/group.md

@@ -0,0 +1,13 @@
+# 群
+::: tip
+需要机器人拥有群聊权限
+:::
+## 发送群消息
+- sendGroupMessage
+- 将返回发送的消息对象
+
+| 参数名      | 类型       | 是否必填 | 描述   |
+|----------|----------|------|------|
+| group_id | string   |是| 群id  |
+| message  | Sendable |是| 消息内容 |
+```

docs/src/api/guild.md

@@ -0,0 +1,61 @@
+# 频道
+## 获取频道列表
+- getGuildList
+- 将返回[Guild](https://bot.q.qq.com/wiki/develop/api-v2/server-inter/channel/manage/guild/model.html#guild)[]
+
+| 参数名 | 类型 | 是否必填 | 描述|
+|-----|----|------|----|
+
+## 获取子频道列表
+- getChannelList
+- 将返回 [Channel](https://bot.q.qq.com/wiki/develop/api-v2/server-inter/channel/manage/channel/model.html#channel)对象
+
+| 参数名 | 类型 | 是否必填 | 描述|
+|-----|----|------|----|
+| guild_id|string|是|频道id|
+## 获取频道成员列表
+::: tip
+仅私域机器人可用
+:::
+- getGuildMemberList
+- 将返回[Member](https://bot.q.qq.com/wiki/develop/api-v2/server-inter/channel/role/member/model.html#member)[]
+
+| 参数名 | 类型 | 是否必填 | 描述|
+|-----|----|------|----|
+| guild_id|string|是|频道id|
+## 发送频道消息
+- sendGuildMessage
+- 将返回发送的消息对象
+
+| 参数名        | 类型       | 是否必填 | 描述    |
+|------------|----------|------|-------|
+| channel_id | string   |是| 子频道id |
+| message    | Sendable |是| 消息内容  |
+## 获取频道消息
+- getGuildMessage
+- 将返回发送的消息对象
+
+| 参数名        | 类型     | 是否必填 | 描述    |
+|------------|--------|------|-------|
+| channel_id | string |是| 子频道id |
+| message_id | string |是| 消息id  |
+## 撤回频道消息
+- recallGuildMessage
+- 须传入对应子频道的channel_id和message_id
+- 将返回是否撤回成功
+
+| 参数名        | 类型     | 是否必填 | 描述    |
+|------------|--------|------|-------|
+| channel_id | string |是| 子频道id |
+| message_id | string |是| 消息id  |
+## 禁言频道成员
+- muteGuildMember
+
+| 参数名       | 类型     | 是否必填 | 描述   |
+|-----------|--------|------|------|
+| guild_id  | string |是| 频道id |
+| member_id | string |是| 成员id |
+
+
+
+

docs/src/config.md

@@ -8,7 +8,6 @@ layout: doc
 |----------|---------------------|---------------------------------------|-------|
 | appid    | string              | qq机器人的appid 必填                        | -     |
 | secret   | string              | qq机器人的secret 必填                       | -     |
-| token    | string              | qq机器人的secret                          | -     |
 | sandbox  | boolean             | 是否使用沙箱环境                              | false |
 | intents  | [Intent](#intent)[] | 监听哪些官方事件 必填   | -     |
 | logLevel | string              | 输出日志等级                                | info  |

docs/src/interface/index.md

@@ -0,0 +1 @@
+## Interface