@lobehub/chat 0.111.3 → 0.111.5

package/docs/{Development-Guide → Development}/Feature-Development.zh-CN.md

@@ -1,4 +1,4 @@
-## 如何开发一个新功能
+# 如何开发一个新功能
 
 LobeChat 基于 Next.js 框架构建，使用 TypeScript 作为主要开发语言。在开发新功能时，我们需要遵循一定的开发流程，以确保代码的质量和稳定性。大致的流程分为以下五步：
 
@@ -10,6 +10,14 @@ LobeChat 基于 Next.js 框架构建，使用 TypeScript 作为主要开发语
 
 我们以 "会话消息" 功能为例，以下是实现这个功能的简要步骤：
 
+#### TOC
+
+- [1. 定义路由](#1-定义路由)
+- [2. 定义数据结构](#2-定义数据结构)
+- [3. 创建 Zustand Store](#3-创建-zustand-store)
+- [4. 创建页面与组件](#4-创建页面与组件)
+- [5. 功能绑定](#5-功能绑定)
+
 ## 1. 定义路由
 
 在 `src/app` 目录下，我们需要定义一个新的路由来承载 "会话消息" 页面。一般来说，我们会在 `src/app` 下创建一个新的文件夹，例如 `chat`，并且在这个文件夹中创建 `page.tsx`文件，在该文件中导出 React 组件作为页面的主体。

package/docs/Development/Folder-Structure.md

@@ -0,0 +1,40 @@
+# Directory Structure
+
+The directory structure of LobeChat is as follows:
+
+```bash
+src
+├── app        # Main logic and state management related code for the application
+├── components # Reusable UI components
+├── config     # Application configuration files, including client-side and server-side environment variables
+├── const      # Used to define constants, such as action types, route names, etc.
+├── features   # Function modules related to business functions, such as agent settings, plugin development pop-ups, etc.
+├── hooks      # Custom utility hooks reused throughout the application
+├── layout     # Application layout components, such as navigation bars, sidebars, etc.
+├── locales    # Internationalization language files
+├── services   # Encapsulated backend service interfaces, such as HTTP requests
+├── store      # Zustand store for state management
+├── types      # TypeScript type definition files
+└── utils      # Common utility functions
+```
+
+## app
+
+In the `app` folder, we organize each route page according to the app router's [Route Groups](https://nextjs.org/docs/app/building-your-application/routing/route-groups) to separately handle the implementation of desktop and mobile code. Taking the file structure of the `welcome` page as an example:
+
+```bash
+welcome
+├── (desktop)               # Desktop implementation
+│   ├── features            # Desktop-specific features
+│   ├── index.tsx           # Main entry file for desktop
+│   └── layout.desktop.tsx  # Desktop layout component
+├── (mobile)                # Mobile implementation
+│   ├── features            # Mobile-specific features
+│   ├── index.tsx           # Main entry file for mobile
+│   └── layout.mobile.tsx   # Mobile layout component
+├── features                # This folder contains features code shared by both desktop and mobile, such as the Banner component
+│   └── Banner
+└── page.tsx                # This is the main entry file for the page, used to load desktop or mobile code based on the device type
+```
+
+In this way, we can clearly distinguish and manage desktop and mobile code, while also easily reusing code required on both devices, thereby improving development efficiency and maintaining code cleanliness and maintainability.

package/docs/Development/Resources.md

@@ -0,0 +1,19 @@
+# Resources and References
+
+The design and development of LobeChat would not have been possible without the excellent projects in the community and ecosystem. We have used or referred to some outstanding resources and guides in the design and development process. Here are some key reference resources for developers to refer to during the development and learning process:
+
+1. **OpenAI API Guide**: We use OpenAI's API to access and process AI conversation data. You can check out the [OpenAI API Guide](https://platform.openai.com/docs/api-reference/introduction) for more details.
+
+2. **OpenAI SDK**: We use OpenAI's Node.js SDK to interact with OpenAI's API. You can view the source code and documentation on the [OpenAI SDK](https://github.com/openai/openai-node) GitHub repository.
+
+3. **AI SDK**: We use Vercel's AI SDK to access and process AI conversation data. You can refer to the documentation of [AI SDK](https://sdk.vercel.ai/docs) for more details.
+
+4. **LangChain**: Our early conversation feature was implemented based on LangChain. You can visit [LangChain](https://langchain.com) to learn more about it.
+
+5. **Chat-Next-Web**: Chat Next Web is an excellent project, and some of LobeChat's features and workflows are referenced from its implementation. You can view the source code and documentation on the [Chat-Next-Web](https://github.com/Yidadaa/ChatGPT-Next-Web) GitHub repository.
+
+6. **Next.js Documentation**: Our project is built on Next.js, and you can refer to the [Next.js Documentation](https://nextjs.org/docs) for more information about Next.js.
+
+7. **FlowGPT**: FlowGPT is currently the world's largest Prompt community, and some of the agents in LobeChat come from active authors in FlowGPT. You can visit [FlowGPT](https://flowgpt.com/) to learn more about it.
+
+We will continue to update and supplement this list to provide developers with more reference resources.

package/docs/Development/Steup-Development.md

@@ -0,0 +1,69 @@
+# Environment Setup Guide
+
+Welcome to the LobeChat development environment setup guide.
+
+#### TOC
+
+- [Online Development](#online-development)
+- [Local Development](#local-development)
+  - [Development Environment Requirements](#development-environment-requirements)
+  - [Project Setup](#project-setup)
+
+## Online Development
+
+If you have access to GitHub Codespaces, you can click the button below to enter the online development environment with just one click:
+
+[![][codespaces-shield]][codespaces-link]
+
+## Local Development
+
+Before starting development on LobeChat, you need to install and configure some necessary software and tools in your local environment. This document will guide you through these steps.
+
+### Development Environment Requirements
+
+First, you need to install the following software:
+
+- Node.js: LobeChat is built on Node.js, so you need to install Node.js. We recommend installing the latest stable version.
+- Yarn: We use Yarn as the preferred package manager. You can download and install it from the Yarn official website.
+- PNPM: We use PNPM as an auxiliary package manager. You can download and install it from the PNPM official website.
+- Git: We use Git for version control. You can download and install it from the Git official website.
+- IDE: You can choose your preferred integrated development environment (IDE). We recommend using WebStorm, a powerful IDE particularly suitable for TypeScript development.
+
+### Project Setup
+
+After installing the above software, you can start setting up the LobeChat project.
+
+1. **Get the code**: First, you need to clone the LobeChat codebase from GitHub. Run the following command in the terminal:
+
+```bash
+git clone https://github.com/lobehub/lobe-chat.git
+```
+
+2. **Install dependencies**: Then, navigate to the project directory and use Yarn to install the project's dependencies:
+
+```bash
+cd lobe-chat
+yarn install
+```
+
+If you are using PNPM, you can execute:
+
+```bash
+cd lobe-chat
+pnpm install
+```
+
+3. **Start the development server**: After installing the dependencies, you can start the development server:
+
+```bash
+yarn run dev
+```
+
+Now, you can open `http://localhost:3010` in your browser, and you should see the welcome page of LobeChat. This indicates that you have successfully set up the development environment.
+
+![](https://github-production-user-asset-6210df.s3.amazonaws.com/28616219/274655364-414bc31e-8511-47a3-af17-209b530effc7.png)
+
+During the development process, if you encounter any issues with environment setup or have any questions about LobeChat development, feel free to ask us at any time. We look forward to seeing your contributions!
+
+[codespaces-link]: https://codespaces.new/lobehub/lobe-chat
+[codespaces-shield]: https://github.com/codespaces/badge.svg

package/docs/{Development-Guide → Development}/Steup-Development.zh-CN.md

@@ -1,7 +1,14 @@
-# LobeChat 环境设置指南
+# 环境设置指南
 
 欢迎阅读 LobeChat 的开发环境设置指南。
 
+#### TOC
+
+- [在线开发](#在线开发)
+- [本地开发](#本地开发)
+  - [开发环境需求](#开发环境需求)
+  - [项目设置](#项目设置)
+
 ## 在线开发
 
 如果你有 GitHub Codespaces 的使用权限，可以点击下方按钮一键进入在线开发环境：

package/docs/Development/Test.md

@@ -0,0 +1,87 @@
+# Testing Guide
+
+LobeChat's testing strategy includes unit testing and end-to-end (E2E) testing. Below are detailed explanations of each type of testing:
+
+#### TOC
+
+- [Unit Testing](#unit-testing)
+- [🚧 End-to-End Testing](#-end-to-end-testing)
+- [Development Testing](#development-testing)
+  - [1. Unit Testing](#1-unit-testing)
+- [Testing Strategy](#testing-strategy)
+
+## Unit Testing
+
+Unit testing is used to test the functionality of independent units in the application, such as components, functions, utility functions, etc. We use [vitest][vitest-url] for unit testing.
+
+To run unit tests, you can use the following command:
+
+```
+npm run test
+```
+
+This will run all unit tests and generate a test report.
+
+We encourage developers to write corresponding unit tests while writing code to ensure the quality and stability of the code.
+
+## 🚧 End-to-End Testing
+
+End-to-end testing is used to test the functionality and performance of the application in a real environment. It simulates real user operations and verifies the application's performance in different scenarios.
+
+Currently, there is no integrated end-to-end testing in LobeChat. We will gradually introduce end-to-end testing in subsequent iterations.
+
+## Development Testing
+
+### 1. Unit Testing
+
+Unit testing is conducted on the smallest testable units in the application, usually functions, components, or modules. In LobeChat, we use [vitest][vitest-url] for unit testing.
+
+#### Writing Test Cases
+
+Before writing unit tests, you need to create a directory with the same name as the file to be tested and name the test file `<filename>.test.ts`. For example, if you want to test the `src/utils/formatDate.ts` file, the test file should be named `src/utils/formatDate.test.ts`.
+
+In the test file, you can use the `describe` and `it` functions to organize and write test cases. The `describe` function is used to create a test suite, and the `it` function is used to write specific test cases.
+
+```typescript
+import { formatNumber } from './formatNumber';
+
+describe('formatNumber', () => {
+  it('should format number with comma separator', () => {
+    const result = formatNumber(1000);
+    expect(result).toBe('1,000');
+  });
+
+  it('should return the same number if it is less than 1000', () => {
+    const result = formatNumber(500);
+    expect(result).toBe('500');
+  });
+});
+```
+
+In test cases, you can use the `expect` function to assert whether the test results meet expectations. The `expect` function can be used with various matchers, such as `toBe`, `toEqual`, `toBeTruthy`, etc.
+
+#### Running Unit Tests
+
+Execute unit tests by running the following command:
+
+```
+npm run test
+```
+
+This will run all unit tests and output the test results.
+
+## Testing Strategy
+
+To write effective test cases, you can consider the following testing strategies:
+
+- **Boundary Testing**: Test the boundary conditions of inputs, such as minimum value, maximum value, empty value, etc.
+- **Exception Testing**: Test the code handling exceptional cases, such as error handling, fallback in exceptional situations, etc.
+- **Functional Testing**: Test whether various functional modules of the application work properly, including user interaction, data processing, etc.
+- **Compatibility Testing**: Test the compatibility of the application on different browsers and devices.
+- **Performance Testing**: Test the performance of the application under different loads, such as response time, resource utilization, etc.
+
+Also, ensure that your test cases have good coverage, covering critical code and functionality in the application.
+
+By properly writing and executing unit tests, integration tests, and end-to-end tests, you can improve the quality and stability of the application and promptly identify and fix potential issues.
+
+[vitest-url]: https://vitest.dev/

package/docs/{Development-Guide → Development}/Test.zh-CN.md

@@ -1,7 +1,15 @@
-# LobeChat 测试指南
+# 测试指南
 
 LobeChat 的测试策略包括单元测试和端到端 (E2E) 测试。下面是每种测试的详细说明：
 
+#### TOC
+
+- [单元测试](#单元测试)
+- [🚧 端到端测试](#-端到端测试)
+- [开发测试](#开发测试)
+  - [1. 单元测试](#1-单元测试)
+- [测试策略](#测试策略)
+
 ## 单元测试
 
 单元测试用于测试应用中的独立单元（如组件、函数、工具函数等）的功能。我们使用 [vitest][vitest-url] 进行单元测试。

package/docs/Development/index.md

@@ -0,0 +1,43 @@
+# Technical Development Getting Started Guide
+
+Welcome to the LobeChat technical development getting started guide. LobeChat is an AI conversation application built on the Next.js framework, which integrates a series of technology stacks to achieve diverse functions and features. This guide will provide a detailed introduction to the main technical components of LobeChat and how to configure and use these technologies in your development environment.
+
+#### TOC
+
+- [Basic Technology Stack](#basic-technology-stack)
+- [Folder Directory Structure](#folder-directory-structure)
+
+## Basic Technology Stack
+
+The core technology stack of LobeChat includes:
+
+- **Framework**: We have chosen [Next.js](https://nextjs.org/), a powerful React framework that provides key features such as server-side rendering, routing framework, and Router Handler for our project.
+- **Component Library**: We use [Ant Design (antd)](https://ant.design/) as the basic component library, and also introduce [lobe-ui](https://github.com/lobehub/lobe-ui) as our business component library.
+- **State Management**: We have opted for [zustand](https://github.com/pmndrs/zustand), a lightweight and easy-to-use state management library.
+- **Network Requests**: We use [swr](https://swr.vercel.app/), a React Hooks library for data fetching.
+- **Routing**: For routing management, we directly use the solution provided by [Next.js](https://nextjs.org/) itself.
+- **Internationalization**: We use [i18next](https://www.i18next.com/) to implement multi-language support for the application.
+- **Styling**: We use [antd-style](https://github.com/ant-design/antd-style), a CSS-in-JS library that complements Ant Design.
+- **Unit Testing**: We use [vitest](https://github.com/vitest-dev/vitest) for unit testing.
+
+## Folder Directory Structure
+
+The folder directory structure of LobeChat is as follows:
+
+```bash
+src
+├── app        # Main logic of the application and code related to state management
+├── components # Reusable UI components
+├── config     # Application configuration files, including client-side environment variables and server-side environment variables
+├── const      # Used to define constants, such as action types, route names, etc.
+├── features   # Function modules related to business features, such as Agent settings, plugin development pop-ups, etc.
+├── hooks      # Custom utility hooks reused throughout the application
+├── layout     # Application layout components, such as navigation bars, sidebars, etc.
+├── locales    # Language files for internationalization
+├── services   # Encapsulated backend service interfaces, such as HTTP requests
+├── store      # Zustand store for state management
+├── types      # TypeScript type definition files
+└── utils      # Common utility functions
+```
+
+For a detailed introduction to the directory structure, please refer to: [Folder Directory Structure](Folder-Structure.en-US.md)

package/docs/{Development-Guide → Development}/index.zh-CN.md

@@ -1,7 +1,12 @@
-# LobeChat 技术开发上手指南
+# 技术开发上手指南
 
 欢迎来到 LobeChat 技术开发上手指南。LobeChat 是一款基于 Next.js 框架构建的 AI 会话应用，它汇集了一系列的技术栈，以实现多样化的功能和特性。本指南将详细介绍 LobeChat 的主要技术组成，以及如何在你的开发环境中配置和使用这些技术。
 
+#### TOC
+
+- [基础技术栈](#基础技术栈)
+- [文件夹目录架构](#文件夹目录架构)
+
 ## 基础技术栈
 
 LobeChat 的核心技术栈如下：

package/docs/Home.md

@@ -12,42 +12,61 @@ LobeChat is a open-source, extensible ([Function Calling][fc-url]), high-perform
 
 ![](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/rainbow.png)
 
+<!-- DOCS LIST -->
+
 ### 🤯 LobeChat Usage
 
-- [Custom Agents Guide](Usage-Agents) | [自定义助手指南](Usage-Agents.zh-CN)
-- [Topics Guide](Usage-Topics) | [话题指南](Usage-Topics.zh-CN)
+- [Custom Agents Guide](https://github.com/lobehub/lobe-chat/wiki/Usage-Agents) | [自定义助手指南](https://github.com/lobehub/lobe-chat/wiki/Usage-Agents)
+- [Topic Guide](https://github.com/lobehub/lobe-chat/wiki/Usage-Topics) | [话题指南](https://github.com/lobehub/lobe-chat/wiki/Usage-Topics)
+
+---
+
+### 🛳 Self Hosting
+
+- [Data Statistics](https://github.com/lobehub/lobe-chat/wiki/Analytics) | [数据统计](https://github.com/lobehub/lobe-chat/wiki/Analytics)
+- [Deploying with Azure OpenAI](https://github.com/lobehub/lobe-chat/wiki/Deploy-with-Azure-OpenAI) | [使用 Azure OpenAI 部署](https://github.com/lobehub/lobe-chat/wiki/Deploy-with-Azure-OpenAI)
+- [Docker Deployment Guide](https://github.com/lobehub/lobe-chat/wiki/Docker-Deployment) | [Docker 部署指引](https://github.com/lobehub/lobe-chat/wiki/Docker-Deployment)
+- [LobeChat Environment Variables](https://github.com/lobehub/lobe-chat/wiki/Environment-Variable) | [LobeChat 环境变量](https://github.com/lobehub/lobe-chat/wiki/Environment-Variable)
+- [Maintaining Updates with LobeChat Self-Deployment](https://github.com/lobehub/lobe-chat/wiki/Upstream-Sync) | [LobeChat 自部署保持更新](https://github.com/lobehub/lobe-chat/wiki/Upstream-Sync)
 
 ---
 
-#### 🛳 Self Hosting
+### ⌨️ Development
 
-- [Environment Variables](Environment-Variable) | [环境变量](Environment-Variable.zh-CN)
-- [Maintaining Updates with LobeChat Self-Deployment](Upstream-Sync) | [自部署保持更新](Upstream-Sync.zh-CN)
-- [Deploying with Azure OpenAI](Deploy-with-Azure-OpenAI) | [使用 Azure OpenAI 部署](Deploy-with-Azure-OpenAI.zh-CN)
-- [Docker Deployment Guide](Docker-Deployment) | [Docker 部署指引](Docker-Deployment.zh-CN)
+- [Technical Development Getting Started Guide](https://github.com/lobehub/lobe-chat/wiki/index) | [技术开发上手指南](https://github.com/lobehub/lobe-chat/wiki/index)
+- [Architecture Design](https://github.com/lobehub/lobe-chat/wiki/Architecture) | [架构设计](https://github.com/lobehub/lobe-chat/wiki/Architecture)
+- [Conversation API Implementation Logic](https://github.com/lobehub/lobe-chat/wiki/Chat-API) | [会话 API 实现逻辑](https://github.com/lobehub/lobe-chat/wiki/Chat-API)
+- [Data Store Selector](https://github.com/lobehub/lobe-chat/wiki/Data-Store-Selectors) | [数据存储取数模块](https://github.com/lobehub/lobe-chat/wiki/Data-Store-Selectors)
+- [Directory Structure](https://github.com/lobehub/lobe-chat/wiki/Folder-Structure) | [目录架构](https://github.com/lobehub/lobe-chat/wiki/Folder-Structure)
+- [Environment Setup Guide](https://github.com/lobehub/lobe-chat/wiki/Steup-Development) | [环境设置指南](https://github.com/lobehub/lobe-chat/wiki/Steup-Development)
+- [How to Develop a New Feature](https://github.com/lobehub/lobe-chat/wiki/Feature-Development) | [如何开发一个新功能](https://github.com/lobehub/lobe-chat/wiki/Feature-Development)
+- [Resources and References](https://github.com/lobehub/lobe-chat/wiki/Resources) | [资源与参考](https://github.com/lobehub/lobe-chat/wiki/Resources)
+- [Testing Guide](https://github.com/lobehub/lobe-chat/wiki/Test) | [测试指南](https://github.com/lobehub/lobe-chat/wiki/Test)
 
 ---
 
 ### 🤖 Agents
 
-- [Agent Index and Submit][agent-index] | [助手索引与提交][agent-index-cn]
+- [Agent Index and Submit](https://github.com/lobehub/lobe-chat-agents) | [助手索引与提交](https://github.com/lobehub/lobe-chat-agents/blob/main/README.zh-CN.md)
 
 ---
 
 ### 🧩 Plugins
 
-- [Plugin Index and Submit][plugin-index] | [插件索引与提交][plugin-index-cn]
-- [Plugin Development](Plugin-Development) | [插件开发](Plugin-Development.zh-CN)
-- [Plugin SDK Docs][plugin-sdk] | [插件 SDK 文档][plugin-skd-cn]
+- [LobeChat Plugin Development](https://github.com/lobehub/lobe-chat/wiki/Plugin-Development) | [LobeChat 插件开发](https://github.com/lobehub/lobe-chat/wiki/Plugin-Development)
+- [Plugin Index and Submit](https://github.com/lobehub/lobe-chat-plugins) | [插件索引与提交](https://github.com/lobehub/lobe-chat-plugins/blob/main/README.zh-CN.md)
+- [Plugin SDK Docs](https://chat-plugin-sdk.lobehub.com) | [插件 SDK 文档](https://chat-plugin-sdk.lobehub.com)
 
 ---
 
-#### 📊 Other
+### 📊 Others
 
-- [Lighthouse Report](Lighthouse) | [性能测试](Lighthouse.zh-CN)
+- [Lighthouse Reports](https://github.com/lobehub/lobe-chat/wiki/Lighthouse) | [Lighthouse 测试报告](https://github.com/lobehub/lobe-chat/wiki/Lighthouse)
 
 ---
 
+ <!-- DOCS LIST -->
+
 <details><summary><h4>📝 License</h4></summary>
 
 [![][fossa-license-shield]][fossa-license-url]
@@ -59,14 +78,8 @@ This project is [MIT][license-url] licensed.
 
 <!-- LINK GROUP -->
 
-[agent-index]: https://github.com/lobehub/lobe-chat-agents
-[agent-index-cn]: https://github.com/lobehub/lobe-chat-agents/blob/main/README.zh-CN.md
 [fc-url]: https://sspai.com/post/81986
 [fossa-license-shield]: https://app.fossa.com/api/projects/git%2Bgithub.com%2Flobehub%2Flobe-chat.svg?type=large
 [fossa-license-url]: https://app.fossa.com/projects/git%2Bgithub.com%2Flobehub%2Flobe-chat
 [license-url]: https://github.com/lobehub/lobe-chat/blob/main/LICENSE
-[plugin-index]: https://github.com/lobehub/lobe-chat-plugins
-[plugin-index-cn]: https://github.com/lobehub/lobe-chat-plugins/blob/main/README.zh-CN.md
-[plugin-sdk]: https://chat-plugin-sdk.lobehub.com
-[plugin-skd-cn]: https://chat-plugin-sdk.lobehub.com
 [profile-url]: https://github.com/lobehub

package/docs/_Sidebar.md

@@ -4,37 +4,47 @@
 
 - [TOC](Home) | [目录](Home)
 
+<!-- DOCS LIST -->
+
 #### 🤯 LobeChat Usage
 
-- [Custom Agents Guide](Usage-Agents) | [中文](Usage-Agents.zh-CN)
-- [Topics Guide](Usage-Topics) | [中文](Usage-Topics.zh-CN)
+- [Custom Agents Guide](https://github.com/lobehub/lobe-chat/wiki/Usage-Agents) | [中文](https://github.com/lobehub/lobe-chat/wiki/Usage-Agents)
+- [Topic Guide](https://github.com/lobehub/lobe-chat/wiki/Usage-Topics) | [中文](https://github.com/lobehub/lobe-chat/wiki/Usage-Topics)
 
 #### 🛳 Self Hosting
 
-- [Environment Variables](Environment-Variable) | [中文](Environment-Variable.zh-CN)
-- [Upstream Sync](Upstream-Sync) | [中文](Upstream-Sync.zh-CN)
-- [Deploying with Azure OpenAI](Deploy-with-Azure-OpenAI) | [中文](Deploy-with-Azure-OpenAI.zh-CN)
-- [Docker Deployment Guide](Docker-Deployment) | [中文](Docker-Deployment.zh-CN)
+- [Data Statistics](https://github.com/lobehub/lobe-chat/wiki/Analytics) | [中文](https://github.com/lobehub/lobe-chat/wiki/Analytics)
+- [Deploying with Azure OpenAI](https://github.com/lobehub/lobe-chat/wiki/Deploy-with-Azure-OpenAI) | [中文](https://github.com/lobehub/lobe-chat/wiki/Deploy-with-Azure-OpenAI)
+- [Docker Deployment Guide](https://github.com/lobehub/lobe-chat/wiki/Docker-Deployment) | [中文](https://github.com/lobehub/lobe-chat/wiki/Docker-Deployment)
+- [LobeChat Environment Variables](https://github.com/lobehub/lobe-chat/wiki/Environment-Variable) | [中文](https://github.com/lobehub/lobe-chat/wiki/Environment-Variable)
+- [Maintaining Updates with LobeChat Self-Deployment](https://github.com/lobehub/lobe-chat/wiki/Upstream-Sync) | [中文](https://github.com/lobehub/lobe-chat/wiki/Upstream-Sync)
+
+#### ⌨️ Development
+
+- [Technical Development Getting Started Guide](https://github.com/lobehub/lobe-chat/wiki/index) | [中文](https://github.com/lobehub/lobe-chat/wiki/index)
+- [Architecture Design](https://github.com/lobehub/lobe-chat/wiki/Architecture) | [中文](https://github.com/lobehub/lobe-chat/wiki/Architecture)
+- [Conversation API Implementation Logic](https://github.com/lobehub/lobe-chat/wiki/Chat-API) | [中文](https://github.com/lobehub/lobe-chat/wiki/Chat-API)
+- [Data Store Selector](https://github.com/lobehub/lobe-chat/wiki/Data-Store-Selectors) | [中文](https://github.com/lobehub/lobe-chat/wiki/Data-Store-Selectors)
+- [Directory Structure](https://github.com/lobehub/lobe-chat/wiki/Folder-Structure) | [中文](https://github.com/lobehub/lobe-chat/wiki/Folder-Structure)
+- [Environment Setup Guide](https://github.com/lobehub/lobe-chat/wiki/Steup-Development) | [中文](https://github.com/lobehub/lobe-chat/wiki/Steup-Development)
+- [How to Develop a New Feature](https://github.com/lobehub/lobe-chat/wiki/Feature-Development) | [中文](https://github.com/lobehub/lobe-chat/wiki/Feature-Development)
+- [Resources and References](https://github.com/lobehub/lobe-chat/wiki/Resources) | [中文](https://github.com/lobehub/lobe-chat/wiki/Resources)
+- [Testing Guide](https://github.com/lobehub/lobe-chat/wiki/Test) | [中文](https://github.com/lobehub/lobe-chat/wiki/Test)
 
 #### 🤖 Agents
 
-- [Agent Index][agent-index] | [中文][agent-index-cn]
+- [Agent Index and Submit](https://github.com/lobehub/lobe-chat-agents) | [中文](https://github.com/lobehub/lobe-chat-agents/blob/main/README.zh-CN.md)
 
 #### 🧩 Plugins
 
-- [Plugin Index][plugin-index] | [中文][plugin-index-cn]
-- [Plugin Development](Plugin-Development) | [中文](Plugin-Development.zh-CN)
-- [Plugin SDK Docs][plugin-sdk] | [中文][plugin-skd-cn]
+- [LobeChat Plugin Development](https://github.com/lobehub/lobe-chat/wiki/Plugin-Development) | [中文](https://github.com/lobehub/lobe-chat/wiki/Plugin-Development)
+- [Plugin Index and Submit](https://github.com/lobehub/lobe-chat-plugins) | [中文](https://github.com/lobehub/lobe-chat-plugins/blob/main/README.zh-CN.md)
+- [Plugin SDK Docs](https://chat-plugin-sdk.lobehub.com) | [中文](https://chat-plugin-sdk.lobehub.com)
 
-#### 📊 Other
+#### 📊 Others
 
-- [Lighthouse Report](Lighthouse) | [中文](Lighthouse.zh-CN)
+- [Lighthouse Reports](https://github.com/lobehub/lobe-chat/wiki/Lighthouse) | [中文](https://github.com/lobehub/lobe-chat/wiki/Lighthouse)
 
-<!-- LINK GROUP -->
+ <!-- DOCS LIST -->
 
-[agent-index]: https://github.com/lobehub/lobe-chat-agents
-[agent-index-cn]: https://github.com/lobehub/lobe-chat-agents/blob/main/README.zh-CN.md
-[plugin-index]: https://github.com/lobehub/lobe-chat-plugins
-[plugin-index-cn]: https://github.com/lobehub/lobe-chat-plugins/blob/main/README.zh-CN.md
-[plugin-sdk]: https://chat-plugin-sdk.lobehub.com
-[plugin-skd-cn]: https://chat-plugin-sdk.lobehub.com
+<!-- LINK GROUP -->

package/locales/en_US/chat.json

@@ -73,5 +73,5 @@
     "dragDesc": "Drag and drop files here, support uploading multiple images. Hold down Shift to send images directly.",
     "dragTitle": "Upload Image"
   },
-  "warp": "换行"
+  "warp": "Warp"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lobehub/chat",
-  "version": "0.111.3",
+  "version": "0.111.5",
   "description": "Lobe Chat - an open-source, high-performance chatbot framework that supports speech synthesis, multimodal, and extensible Function Call plugin system. Supports one-click free deployment of your private ChatGPT/LLM web application.",
   "keywords": [
     "framework",
@@ -30,6 +30,7 @@
     "build:analyze": "ANALYZE=true next build",
     "build:docker": "DOCKER=true next build",
     "dev": "next dev -p 3010",
+    "docs": "lobe-i18n md && npm run workflow:docs",
     "i18n": "npm run workflow:i18n && lobe-i18n",
     "lint": "npm run lint:ts && npm run lint:style && npm run type-check && npm run lint:circular",
     "lint:circular": "dpdm src/**/*.ts  --warning false  --tree false  --exit-code circular:1  -T true",
@@ -46,6 +47,7 @@
     "test:coverage": "vitest run --coverage --passWithNoTests",
     "test:update": "vitest -u",
     "type-check": "tsc --noEmit",
+    "workflow:docs": "bun scripts/docsWorkflow/index.ts",
     "workflow:i18n": "ts-node --project ./tsconfig.json scripts/i18nWorkflow/index.ts",
     "workflow:readme": "bun scripts/readmeWorkflow/index.ts"
   },
@@ -153,18 +155,23 @@
     "dpdm": "^3",
     "eslint": "^8",
     "fake-indexeddb": "^5",
+    "glob": "^10",
     "husky": "^8",
     "jsdom": "^23.0.0",
     "lint-staged": "^15",
     "lodash": "^4",
     "markdown-table": "^3",
     "node-fetch": "^3",
+    "p-map": "^7",
     "prettier": "^3",
     "remark-cli": "^11",
+    "remark-parse": "^10",
     "semantic-release": "^21",
     "stylelint": "^15",
     "ts-node": "^10",
     "typescript": "^5",
+    "unified": "^11",
+    "unist-util-visit": "^5",
     "vitest": "0.34.6"
   },
   "publishConfig": {

package/scripts/docsWorkflow/const.ts

@@ -0,0 +1,14 @@
+import { globSync } from 'glob';
+import { resolve } from 'node:path';
+
+export const WIKI_URL = 'https://github.com/lobehub/lobe-chat/wiki/';
+export const ROOT = resolve(__dirname, '../..');
+export const DOCS_DIR = resolve(ROOT, 'docs');
+export const HOME_PATH = resolve(DOCS_DIR, 'Home.md');
+export const SIDEBAR_PATH = resolve(DOCS_DIR, '_Sidebar.md');
+export const docsFiles = globSync(resolve(DOCS_DIR, '**/*.md'), {
+  ignore: ['Home.md', '_Sidebar.md', '_Footer.md'],
+  nodir: true,
+}).filter((file) => !file.includes('.zh-CN.md'));
+
+export const SPLIT = '<!-- DOCS LIST -->';

package/scripts/docsWorkflow/index.ts

@@ -0,0 +1,73 @@
+import { consola } from 'consola';
+import { relative, resolve } from 'node:path';
+import pMap from 'p-map';
+import urlJoin from 'url-join';
+
+import { DOCS_DIR, HOME_PATH, SIDEBAR_PATH, WIKI_URL, docsFiles } from './const';
+import toc from './toc';
+import { genMdLink, getTitle, updateDocs } from './utils';
+
+const run = async () => {
+  consola.info(`Find ${docsFiles.length} entry doc files`);
+  const docs: any = await pMap(toc, async (item) => {
+    const childrenFiles = docsFiles.filter((file) => file.includes(resolve(DOCS_DIR, item.dir)));
+
+    const children: any = await pMap(childrenFiles, async (path) => {
+      const paths = {
+        cn: path.replace('.md', '.zh-CN.md'),
+        en: path,
+      };
+      const links = {
+        cn: urlJoin(WIKI_URL, relative(DOCS_DIR, paths.cn).split('/')[1].replace('.zh-CN.md', '')),
+        en: urlJoin(WIKI_URL, relative(DOCS_DIR, paths.en).split('/')[1].replace('.md', '')),
+      };
+      const titles = {
+        cn: await getTitle(paths.cn),
+        en: await getTitle(paths.en),
+      };
+      return {
+        links,
+        paths,
+        titles,
+      };
+    });
+    return {
+      children: children,
+      ...item,
+    };
+  });
+
+  let homeContent = '';
+  let sidebarContent = '';
+
+  docs.forEach((item: any) => {
+    homeContent += `### ${item.title}\n\n`;
+    sidebarContent += `#### ${item.title}\n\n`;
+    const data = [...(item.children || []), ...(item.extra || [])];
+    data
+      .sort((a, b) => {
+        if (a.links.en.includes('index')) return -1;
+        if (b.links.en.includes('index')) return 1;
+        return a.titles.en.localeCompare(b.titles.en);
+      })
+      .forEach((child: any) => {
+        homeContent += `  - ${genMdLink(child.titles.en, child.links.en)} | ${genMdLink(
+          child.titles.cn,
+          child.links.cn,
+        )}\n`;
+        sidebarContent += `- ${genMdLink(child.titles.en, child.links.en)} | ${genMdLink(
+          '中文',
+          child.links.cn,
+        )}\n`;
+      });
+    homeContent += `\n\n---\n\n`;
+    sidebarContent += `\n\n`;
+  });
+
+  updateDocs(HOME_PATH, homeContent);
+  consola.success(`Update Home.md`);
+  updateDocs(SIDEBAR_PATH, sidebarContent);
+  consola.success(`Update _Sidebar.md`);
+};
+
+run();