Merge pull request openimsdk#227 from skiffer-git/add-outline

add docs: faq and features

Author: skiffer-git

docs/guides/gettingStarted/faq.mdx

@@ -0,0 +1,73 @@
+---
+title: '常见问题'
+sidebar_position: 10
+---
+
+## 一、如何升级
+
+在同一大版本内，不同小版本之间的数据是兼容的。例如，版本 **3.8.0** 的数据可以在升级到 **3.8.2** 后正常运行。本文将重点介绍这种升级情况的具体操作步骤。
+
+### Docker 部署
+
+1. **进入已有的 `openim-docker` 目录：**
+    ```bash
+    cd openim-docker
+    ```
+
+2. **编辑 `.env` 文件，修改相应的镜像标签（tag）。例如，将：**
+    ```env
+    OPENIM_SERVER_IMAGE=openim/openim-server:release-v3.8.0
+    ```
+    **修改为：**
+    ```env
+    OPENIM_SERVER_IMAGE=openim/openim-server:release-v3.8.2
+    ```
+
+3. **停止现有的 Docker 服务：**
+    ```bash
+    docker compose down
+    ```
+
+4. **启动更新后的 Docker 服务：**
+    ```bash
+    docker compose up -d
+    ```
+
+### 源码部署
+
+1. **进入已有的 `open-im-server` 目录：**
+    ```bash
+    cd open-im-server
+    ```
+
+2. **停止当前服务：**
+    ```bash
+    mage stop
+    ```
+
+3. **切换分支并更新代码：**
+    ```bash
+    git pull
+    ```
+
+4. **编译并启动服务：**
+    ```bash
+    mage
+    mage start
+    ```
+
+---
+
+
+
+
+---
+## 二、 如何迁移数据
+
+
+---
+## 三、 如何清除数据
+
+---
+## 四、 发送文本消息正常，但发送图片失败
+---

docs/guides/introduction/features.mdx

@@ -0,0 +1,151 @@
+---
+title: '开源功能明细'
+hide_title: true
+sidebar_position: 3
+---
+
+## 开源版功能明细
+
+开源版包含以下组件，每个组件的具体功能描述如下：
+
+### 1. IM SDK/Server
+
+- **功能描述：**
+  - 提供即时通讯的基础功能。
+  - 由客户端 SDK 和服务端 Server 组成。
+- **特性：**
+  - 不包含用户界面（UI），需要开发者自行集成到应用中。
+  - 支持消息发送、接收及管理等核心功能。
+
+### 2. 客户端 UI
+
+- **功能描述：**
+  - 提供demo，仅用于演示如何引入和使用客户端 SDK。
+- **特性：**
+  - 提供基础的用户界面示例，帮助开发者理解 SDK 的集成方式。
+  - 不包括完整的应用功能，需根据需求自行扩展。
+  - 完整的客户端UI不开源。
+
+### 3. 音视频通话
+
+- **功能描述：**
+  - 支持一对一的音视频通话功能。
+- **特性：**
+  - 提供基本的音视频通话接口。
+  - 群组音视频通话或视频会议功能不开源。
+
+### 4. 管理后台前端
+
+- **功能描述：**
+  - 用于管理和展示 IM 系统的前端界面。
+- **特性：**
+  - 提供基本的后台管理功能，如用户管理、消息管理、配置中心等。
+  - 前端代码不开源。
+---
+
+
+
+## IM SDK/Server 功能说明
+
+本文档详细介绍IM SDK/Server 开源版的各项功能，帮助用户了解其具体能力。
+
+### 账号功能
+
+- **注册及登录**
+  - 支持手机号注册、邮箱注册及验证码登录。
+- **个人信息管理**
+  - 用户可以查看和修改个人信息。
+- **多语言设置**
+  - 支持多语言界面设置。
+- **密码管理**
+  - 提供修改密码和忘记密码功能。
+
+
+### 好友功能
+
+- **基本操作**
+  - 支持查找、申请、搜索、添加及删除好友。
+- **好友申请**
+  - 支持同意和拒绝好友申请。
+- **好友备注**
+  - 用户可以为好友添加备注信息。
+- **添加好友权限**
+  - 支持是否允许添加好友的设置。
+- **实时同步**
+  - 好友列表及好友资料支持实时同步。
+
+### 黑名单功能
+  - 支持限制消息和音视频通话。
+  - 黑名单列表实时同步。
+  - 支持添加和移出黑名单。
+
+### 群组功能
+
+- **群组管理**
+  - 支持创建和解散群组。
+- **群成员管理**
+  - 支持申请加群、邀请加群、退出群组及移除群成员。
+- **群资料同步**
+  - 群名、群头像更改及群资料变更通知和实时同步。
+- **进群验证**
+  - 支持进群验证设置。
+- **群主管理**
+  - 支持群主转让。
+- **成员权限设置**
+  - 支持不允许查看其他群成员资料和不允许添加其他群成员为好友的设置。
+  - 支持设置和移除群管理员。
+  - 支持搜索群成员和设置群成员群内资料。
+- **禁言功能**
+  - 支持全体禁言及指定群成员禁言。
+- **群公告**
+  - 支持发布群公告。
+
+### 消息功能
+- **消息类型**
+  - 支持文本、图片、视频、表情、文件、语音、名片、地理位置、自定义及群公告消息。
+- **消息管理**
+  - 支持离线消息、漫游消息、多端消息及历史消息。
+  - 支持单选消息转发和多选消息合并转发。
+  - 支持消息删除、消息清空、消息复制及消息撤回。
+  - 支持撤回后重新编辑消息。
+- **消息互动**
+  - 支持群组内@功能、单聊正在输入、阅后即焚、新消息勿扰、清空聊天记录、新成员查看群聊历史消息、新消息提示。
+  - 支持本地消息搜索。
+
+### 会话功能
+- **支持置顶会话**
+- **删除会话**
+- **搜索本地会话**
+- **会话已读**
+- **会话免打扰**
+
+### REST API
+- **认证管理**
+- **用户管理**
+- **关系链管理**
+- **群组管理**
+- **会话管理**
+- **消息管理**
+
+### Webhook 回调
+- **支持群组回调、消息回调、推送回调、关系链回调及用户回调**
+
+### 容量和性能
+
+- **好友容量**
+  - 支持最多 1 万好友。
+- **群组容量**
+  - 支持 10 万人规模的大群。
+- **同步速度**
+  - 支持秒级同步。
+- **部署方式**
+  - 支持集群部署。
+
+### 互踢策略
+- **所有平台不互踢**
+- **每个平台各只能登录一个设备**
+- **PC端、移动端、Pad端、Web端及小程序端各只能登录一个设备**
+
+### 音视频通话
+- **一对一音视频通话**
+