Skip to content

Commit

Permalink
docs: replace gif and update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
sunshinesmilelk authored and BroKun committed Nov 4, 2024
1 parent 0f3f06e commit d1b7a37
Show file tree
Hide file tree
Showing 20 changed files with 14 additions and 38 deletions.
22 changes: 5 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ Language: English | [简体中文](./README_zh.md)
</p>
<p> </p>


![image](./apps/docs/public/libro_en.png)

---
Expand Down Expand Up @@ -51,8 +52,6 @@ Language: English | [简体中文](./README_zh.md)

## Quick Start

use pip:

```bash
pip install libro
```
Expand All @@ -61,15 +60,6 @@ pip install libro
For more details, please refer to [quick start](./apps/docs/docs/quickstart/index.md)

## Quick Integration

Libro is fully modular, giving you the flexibility to choose from its native capability modules or add custom ones for extended development. To learn more about the modular development approach, check out [mana](https://github.com/difizen/mana).

You can assemble different modules based on your needs to build your own notebook product. For example, you might integrate only the editor-related modules into an IDE or other development environments, or bring in more modules to create a lab-style solution.


For more details, please refer to [quick integration](./apps/docs/docs/integration/index.md)

## New Features

### AI Capability
Expand All @@ -80,18 +70,18 @@ For more details, please refer to [quick integration](./apps/docs/docs/integrati

- Chat
- Contextual Chat in Cells
![image](./apps/docs/public/cell_ai.gif)
![image](./apps/docs/public/cell_chat.gif)

- General AI Chat
![image](./apps/docs/public/ai_chat.gif)

- Code Explanation

![image](./apps/docs/public/code_explain.gif)
![image](./apps/docs/public/cell_explain.gif)

- Code Optimization

![image](./apps/docs/public/code_optimize.gif)
![image](./apps/docs/public/cell_opitimization.gif)

### Prompt Cell

Expand Down Expand Up @@ -145,8 +135,6 @@ For more details, please refer to [sql cell manual](./apps/docs/docs/manual/sql-

### Contact Us

💬 [Chat with us on Discord](https://discord.gg/RbZ9aEKK)
💬 [Chat with us on Discord](https://discord.com/invite/B4V7AWy4)

🤗 [Join our DingTalk Q&A group](https://qr.dingtalk.com/action/joingroup?code=v1,k1,52f1gKWwsZBMrWjXHcQFlOJEQIbbrMO86Iulu3T3ePY=&_dt_no_comment=1&origin=11)

<img src="./apps/docs/public/dingding.jpg" width="30%">
20 changes: 4 additions & 16 deletions README_zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,6 @@

## 快速开始

使用 pip:

```bash
pip install libro
```
Expand All @@ -62,16 +60,6 @@ pip install libro
详情请阅读[快速开始](./apps/docs/docs/quickstart/index.md)

## 快速集成

libro 是完全模块化的,您可以自由选择 libro 提供的原生能力模块,也可以选择增加自定义模块来完成二次开发,模块化研发方案您可以通过 [mana](https://github.com/difizen/mana) 来了解。

您可以根据自己的需求组装不同的模块,构建自己的 notebook 产品。例如仅因为编辑器相关的模块继承到 IDE 或其他研发环境中,或者引入更多模块来组成 lab 形态的产品。

您至少需要安装 jupyter-server 来支持 libro 运行,此时您可以使用 jupyter notebook 的能力,如果需要使用更多 libro 定义的能力,您需要安装 libro-server。

详情请阅读[快速集成](./apps/docs/docs/integration/index.md)


## 新特性

Expand All @@ -83,18 +71,18 @@ libro 是完全模块化的,您可以自由选择 libro 提供的原生能力

- AI 对话
- 基于 Cell 上下文对话
![image](./apps/docs/public/cell_ai_zh.gif)
![image](./apps/docs/public/cell_chat_zh.gif)

- 通用对话
![image](./apps/docs/public/ai_chat_zh.gif)

- 代码解释

![image](./apps/docs/public/code_explain_zh.gif)
![image](./apps/docs/public/cell_explain_zh.gif)

- 代码优化

![image](./apps/docs/public/code_optimize_zh.gif)
![image](./apps/docs/public/cell_opitimization_zh.gif)

### Prompt Cell

Expand Down Expand Up @@ -149,7 +137,7 @@ libro 是完全模块化的,您可以自由选择 libro 提供的原生能力

### 联系我们

💬 [加入 Discord](https://discord.gg/RbZ9aEKK)
💬 [加入 Discord](https://discord.com/invite/B4V7AWy4)

🤗 [加入钉钉答疑群](https://qr.dingtalk.com/action/joingroup?code=v1,k1,52f1gKWwsZBMrWjXHcQFlOJEQIbbrMO86Iulu3T3ePY=&_dt_no_comment=1&origin=11)

Expand Down
4 changes: 2 additions & 2 deletions apps/docs/docs/manual/ai-assistant.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ llm:

从 Cell 右侧工具栏对话按钮唤起,你可以直接与 AI 进行互动,获得与当前代码相关的深入解答和优化建议,提升编程效率。

<img src="../../public/cell_ai_zh.gif" alt="alt text" width="1000" >
<img src="../../public/cell_chat_zh.gif" alt="alt text" width="1000" >

### 通用对话

Expand All @@ -52,4 +52,4 @@ llm:
### 代码优化

从 Cell 右侧工具栏的魔法符号唤起,分析单元格(cell)中的代码,并提供优化建议。
<img src="../../public/code_optimize_zh.gif" alt="alt text" width="1000" >
<img src="../../public/cell_opitimization_zh.gif" alt="alt text" width="1000" >
6 changes: 3 additions & 3 deletions apps/docs/docs/updates/update20241101.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Libro AI 编程助手正式上线!集成了多种智能功能,旨在提升

**Cell 上下文对话**:你可以直接与 AI 进行互动,获得与当前代码相关的深入解答和优化建议,提升编程效率。

<img src="../../public/cell_ai_zh.gif" alt="alt text" width="1000" >
<img src="../../public/cell_chat_zh.gif" alt="alt text" width="1000" >

**通用 AI 对话**:你可以与 AI 进行开放式对话,询问编程相关问题,获取建议和信息,享受智能互动的乐趣。

Expand All @@ -40,13 +40,13 @@ Libro AI 编程助手正式上线!集成了多种智能功能,旨在提升

AI 编程助手帮助你理解 Cell 中代码的功能和逻辑,让编程学习变得更加轻松。

<img src="../../public/code_optimize_zh.gif" alt="alt text" width="1000" >
<img src="../../public/cell_opitimization_zh.gif" alt="alt text" width="1000" >

### 代码优化

AI 编程助手能够分析单元格(cell)中的代码,并提供优化建议。它将帮助你识别潜在的性能瓶颈和改进点,让你的代码更加高效、可读,提升整体编程体验。

<img src="../../public/code_optimize_zh.gif" alt="alt text" width="1000" >
<img src="../../public/cell_opitimization_zh.gif" alt="alt text" width="1000" >

## 历史修复

Expand Down
Loading

0 comments on commit d1b7a37

Please sign in to comment.