Merge pull request #228 from skiffer-git/add-docs

Add docs

Author: skiffer-git

docs/guides/gettingStarted/cluster.mdx

@@ -168,8 +168,13 @@ http {
 
 在两台机器（A 和 B）的 `open-im-server` 目录下执行以下命令以编译和启动服务：
 
-#### 5.1 编译
+中国境内建议设置go代理
+```
+$ go env -w GO111MODULE=on
+$ go env -w GOPROXY=https://goproxy.cn,direct
+```
 
+#### 5.1 编译
 ```bash
 mage
 ```

docs/guides/gettingStarted/env-comp.mdx

@@ -11,7 +11,7 @@ sidebar_position: 1
 | --- | --- |
 | 操作系统 | Linux windows mac 系统 |
 | 硬件资源 | 至少 4G 可用内存 |
-| Golang | v1.21 或更高，[安装参考](https://go.dev/learn/)，设置代理（可选）：`export GOPROXY=https://goproxy.cn,direct` |
+| Golang | v1.21 或更高，[安装参考](https://go.dev/learn/) |
 | Docker | v24.0.5 或更高，[安装参考](https://www.docker.com/get-started/) |
 | Git | v2.17.1 或更高，[安装参考](https://git-scm.com/downloads) |
 

docs/guides/gettingStarted/imSourceCodeDeployment.mdx

@@ -51,8 +51,16 @@ windows 执行
 bootstrap.bat
 ```
 
+
+中国境内建议设置go代理
+```
+$ go env -w GO111MODULE=on
+$ go env -w GOPROXY=https://goproxy.cn,direct
+```
+
 ### 2.5 🛠️ 编译(linux/windows/mac 平台均可用)
 
+
 ```
 mage
 ```

docs/guides/introduction/termDefinition.mdx

@@ -145,3 +145,11 @@ sidebar_position: 2
 - 当用户更换设备或重新安装应用时，系统会拉取并同步这些历史消息，这些消息被称为“漫游消息” 。
 
 ---
+## 对象存储
+- 对象存储（Object Storage）是一种用于存储海量非结构化数据的存储架构，它通过将数据存储为独立的“对象”来管理信息，每个对象包含数据本身、可扩展的元数据以及一个全局唯一的标识符（Key）。
+- 发送文件、图片、视频类型的消息一般先上传到对象存储后生成URL，然后再发送给对方。 整个流程是IMSDK内部完成的，您无需关心。但需您配置minio、oss、cos、s3等其中一种对象存储服务。
+---
+
+
+
+

docs/guides/introduction/version.mdx

@@ -0,0 +1,25 @@
+---
+title: '版本说明'
+hide_title: true
+sidebar_position: 4
+---
+
+# 版本说明
+
+**OpenIMSDK** 长期维护的版本包括：
+
+- **SDK** v3.8
+- **Server** v3.8
+- **Chat** v1.8
+
+在同一大版本内，不同小版本之间数据兼容。我们建议您升级到最新的子版本，升级时请使用 **tag** 以确保版本的准确性和稳定性。
+
+由于维护资源有限，其他版本将不再得到支持。请各位用户尽快完成升级，以享受最新的功能和优化。
+
+## 当前最新稳定版本
+
+- **SDK** v3.8.2
+- **Server** v3.8.2
+- **Chat** v1.8.3
+
+---

docs/guides/solution/campareWithRocetchat.mdx

@@ -0,0 +1,5 @@
+---
+title: '如何在OpenIM和RocketChat之间选择'
+sidebar_position: 7
+
+---

docs/guides/solution/chooseProject.mdx

@@ -0,0 +1,27 @@
+---
+title: '如何选择一款IM开源项目'
+sidebar_position: 5
+---
+
+# 如何选择一款IM开源项目
+
+
+
+## 开放性
+
+## 系统稳定
+
+## 文档齐备
+
+## 详细的测试工具和报告
+
+## 社区活跃度
+
+## 二次开发可集成
+
+## 开发模式和开发语言
+
+
+
+
+

docs/guides/solution/developNewFeatures.mdx

@@ -0,0 +1,28 @@
+---
+title: '如何进行二次开发'
+sidebar_position: 6
+
+---
+
+
+# 如何进行二次开发
+- 如果您需要基于OpenIM开发新特性，首先要确定是针对业务侧还是即时通讯核心逻辑。
+- 由于OpenIM系统本身已经做好了比较多的抽象，大部分聊天的功能已经具备了，不建议修改IM本身。
+- 如果需要增加IM的能力，可以参考以下流程，并提交PR，以保证未来代码统一性。
+
+
+## Server
+
+### rpc功能添加
+
+
+### api功能添加
+
+
+
+## Sdk
+
+
+
+
+

docs/guides/solution/integrate.mdx

@@ -1,5 +1,38 @@
 ---
-title: '如何与已有系统集成'
+title: '如何与现有系统集成'
 sidebar_position: 4
-
 ---
+
+# 如何与现有系统集成
+
+即时通讯（IM）作为一种通信能力，已成为互联网基础设施的重要组成部分，成为许多应用程序不可或缺的功能。如果您开发了一款应用，并希望集成 OpenIM 以实现聊天功能，本文将为您简要介绍集成的步骤。
+
+![OpenIM和业务系统关系图](../introduction/assets/relation.png)
+
+在上述系统关系图中：
+
+- **Your APP Server** 表示您现有应用的服务器端，开发语言不限。用户的个人信息（包括个人资料和密码验证）存储在该服务器中。
+- **Your APP Client** 表示您现有业务的客户端，主流的开发框架均支持。
+
+## Your APP Server 调用 REST API 与 IM Server 对接
+
+1. **新用户注册**：用户注册成功后，调用[用户注册接口](../../restapi/apis/userManagement/userRegister)。
+2. **用户信息修改**：用户修改信息（如头像、昵称、扩展字段）成功后，调用[修改用户信息接口](../../restapi/apis/userManagement/updateUserInfo)。
+3. **获取 IM Token**：在密码校验完成后，调用[获取用户IM Token接口](../../restapi/apis/authenticationManagement/getUserToken)，并将获取到的 IM Token 返回给 **Your APP Client**。
+4. **导入存量用户**：上线前，调用[用户注册接口](../../restapi/apis/userManagement/userRegister)以导入已有用户数据。
+
+## Your APP Client 集成 OpenIM SDK
+
+1. **用户登录**：用户登录成功后，从 **Your APP Server** 获取 IM Token，并调用[IM SDK 登录接口](../../sdks/api/initialization/login)。
+2. **嵌入 IM SDK**：将 IM SDK 嵌入到您的应用中，实现聊天功能的集成。
+3. **用户信息管理**：在获取或修改用户信息时，调用 **Your APP Server** 现有的接口。
+
+
+
+
+
+
+
+
+
+