Merge branch 'develop' into sync/main-1.2.5

Author: da730

README.md

@@ -1,11 +1,49 @@
-# @visactor/vmind
+
+<div align="center">
+   <a href="https://github.com/VisActor#gh-light-mode-only" target="_blank">
+    <img alt="VisActor Logo" width="200" src="https://github.com/VisActor/.github/blob/main/profile/logo_500_200_light.svg"/>
+  </a>
+  <a href="https://github.com/VisActor#gh-dark-mode-only" target="_blank">
+    <img alt="VisActor Logo" width="200" src="https://github.com/VisActor/.github/blob/main/profile/logo_500_200_dark.svg"/>
+  </a>
+</div>
+
+<div align="center">
+  <h1>VMind</h1>
+</div>
+
+<div align="center">
+
+Not just automatic, but also fantastic.Open-source solution for intelligent visualization.
+
+<p align="center">
+  <a href="https://www.visactor.io/vmind">Introduction</a> •
+  <a href="https://www.visactor.io/vmind/example">Demo</a> •
+  <a href="https://www.visactor.io/vmind/guide/Intro_to_VMind">Tutorial</a> •
+  <a href="https://www.visactor.io/vmind/api/VMind_Instance">API</a>•
+  <a href="https://www.visactor.io/vmind/openapi">OpenApi</a>
+</p>
+
+![](https://github.com/visactor/vmind/actions/workflows/bug-server.yml/badge.svg)
+![](https://github.com/visactor/vmind/actions/workflows/unit-test.yml/badge.svg)
+[![npm Version](https://img.shields.io/npm/v/@visactor/vmind.svg)](https://www.npmjs.com/package/@visactor/vmind)
+[![npm Download](https://img.shields.io/npm/dm/@visactor/vmind.svg)](https://www.npmjs.com/package/@visactor/vmind)
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/VisActor/VMind/blob/main/CONTRIBUTING.md#your-first-pull-request)
+
+![](https://img.shields.io/badge/language-TypeScript-red.svg) [![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/visactor/vmind/blob/main/LICENSE)
+
+</div>
+
+
 
 <div align="center">
 
 English | [简体中文](readme-zh.md)
 
 </div>
 
+## 简介
+
 `@visactor/vmind` is an intelligent chart component based on LLM provided by [VisActor](https://www.visactor.io/), including dialog-based chart generation and editing capabilities. It provides a natural language interaction interface, allowing you to easily create chart narrative works with `@visactor/VMind` with just one sentence, and edit them through continuous dialogue, greatly improving your efficiency in creating data visualization works.
 
 The main features of `@visactor/vmind` include:
@@ -17,9 +55,9 @@ The main features of `@visactor/vmind` include:
 
 ## Development Guide
 
-### Demo Page
+### Docs Page
 
-Enter the VChart repository and execute:
+Enter the VMind repository and execute:
 
 ```bash
 # Install dependencies
@@ -28,11 +66,10 @@ $ rush update
 $ rush docs
 ```
 
-Select VMind from the top navigation bar, enter your OpenAI Key, click generate chart, and you can experience VMind.
 
 ### Start the Development Page
 
-Enter the VChart repository and execute:
+Enter the VMind repository and execute:
 
 ```bash
 # Install dependencies

packages/vmind/src/common/schema.ts

@@ -1,9 +1,9 @@
 import { LOCATION, SimpleFieldInfo, VizSchema } from '../typings';
 
 /**
- * generate vizSchema from fieldInfo
- * @param fieldInfo SimpleFieldInfo
- * @returns
+ * Generate a vizSchema from fieldInfo
+ * @param fieldInfo SimpleFieldInfo[] - An array of field information, each element contains the field name, description, type, and role, etc.
+ * @returns Partial<VizSchema> - Returns a partial VizSchema object, containing the transformed field information.
  */
 export const getSchemaFromFieldInfo = (fieldInfo: SimpleFieldInfo[]): Partial<VizSchema> => {
   const schema = {

readme-zh.md

@@ -6,6 +6,31 @@
 
 </div>
 
+
+<div align="center">
+
+不仅自动，还很智能.开源智能可视化解决方案.
+
+<p align="center">
+  <a href="https://www.visactor.io/vmind">Introduction</a> •
+  <a href="https://www.visactor.io/vmind/example">Demo</a> •
+  <a href="https://www.visactor.io/vmind/guide/Intro_to_VMind">Tutorial</a> •
+  <a href="https://www.visactor.io/vmind/api/VMind_Instance">API</a>•
+  <a href="https://www.visactor.io/vmind/openapi">OpenApi</a>
+</p>
+
+![](https://github.com/visactor/vmind/actions/workflows/bug-server.yml/badge.svg)
+![](https://github.com/visactor/vmind/actions/workflows/unit-test.yml/badge.svg)
+[![npm Version](https://img.shields.io/npm/v/@visactor/vmind.svg)](https://www.npmjs.com/package/@visactor/vmind)
+[![npm Download](https://img.shields.io/npm/dm/@visactor/vmind.svg)](https://www.npmjs.com/package/@visactor/vmind)
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/VisActor/VMind/blob/main/CONTRIBUTING.md#your-first-pull-request)
+
+![](https://img.shields.io/badge/language-TypeScript-red.svg) [![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/visactor/vmind/blob/main/LICENSE)
+
+</div>
+
+## 简介
+
 `@visactor/vmind` 是由 [VisActor](https://www.visactor.io/) 为您提供的基于大模型的图表智能组件，包括对话式的图表智能生成与编辑能力。它提供了一个自然语言交互接口，仅需一句话，您就能够轻松使用`@visactor/vmind` 创建图表叙事作品，并通过连续的对话进行编辑，极大地提高您创作数据可视化作品的效率。
 
 `@visactor/vmind` 的主要特点包括：