Skip to content

Commit

Permalink
docs: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
happyapplehorse committed Jan 7, 2024
1 parent 4bd2110 commit e923cd6
Show file tree
Hide file tree
Showing 8 changed files with 14 additions and 11 deletions.
6 changes: 4 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,19 +7,21 @@ and this project adheres to [Semantic Versioning](http://semver.org/).

## [Unreleased]

## [0.5.3] - 2024-01-07

### Fixed

- Fixed the error of using the unimported async_wrapper_with_loop in GroupTalkManager.speaking

## [0.5.2] - 2023-01-02
## [0.5.2] - 2024-01-02

### Fixed

- Fixed the bug that prevents the second conversation from being renamed
- Stop the waiting animation for a conversation when it is deleted
- Fixed the bug where deleting a conversation shows its replies in another window

## [0.5.1] - 2023-01-02
## [0.5.1] - 2024-01-02

### Fixed

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ Depending on the platform you are using, it is best to configure the following o
Otherwise, some features may not work properly, such as code copy and voice related functions.

## Configuration Guide
For detailed configuration instructions, please refer to [here](./docs/guide/configuration.md).
For detailed configuration instructions, please refer to [here](./docs/configuration.md).

# Quick Start

Expand Down
5 changes: 3 additions & 2 deletions README.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,8 @@ Open-interpreter具有执行代码的权限,在开启此功能前请确保你
[^google_key]: 需要提供`GOOGLE_KEY``GOOGLE_CX`。可以从[这里](https://developers.google.com/custom-search/v1/introduction)免费获取。

## 🎬 演示视频
- [AI-Care](https://www.youtube.com/watch?v=gPQ7XV-Q1r8)
- [AI-Care](https://www.bilibili.com/video/BV1ka4y1B7tQ)
- [界面和功能介绍](https://www.bilibili.com/video/BV18T4y1W7eg)

# 兼容性

Expand Down Expand Up @@ -135,7 +136,7 @@ python main.py

## 配置指南

详细的配置说明请查看[这里](./docs/guide/configuration.zh.md)
详细的配置说明请查看[这里](./docs/configuration.zh.md)

# 快速开始

Expand Down
2 changes: 1 addition & 1 deletion docs/guide/configuration.md → docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ tui_config:

You can simply delete the configuration file, for instance `rm ~/.gptui/.config.yml`, and the program will automatically
re-download the default configuration file upon the next launch.
For the configuration file search strategy, refer to [here](../../README.md#installation).
For the configuration file search strategy, refer to [here](https://github.com/happyapplehorse/gptui/blob/main/README.md#installation).

## Configuration Options

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ tui_config:
```

## 恢复默认配置
你可以直接删除配置文件,例如`rm ~/.gptui/.config.yml`,程序将在下次启动时自动重新下载默认的配置文件。配置文件查找策略请参考[这里](../../README.zh.md#使用pip安装)
你可以直接删除配置文件,例如`rm ~/.gptui/.config.yml`,程序将在下次启动时自动重新下载默认的配置文件。配置文件查找策略请参考[这里](https://github.com/happyapplehorse/gptui/blob/main/README.zh.md#使用pip安装)

## 配置选项
目前,你可以进行以下配置:
Expand Down
4 changes: 2 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -63,10 +63,10 @@ nav:
- Getting started: getting_started.md
- Troubleshooting: troubleshooting.md
- Features: features.md
- Configuration: configuration.md
- 配置指南: configuration.zh.md
- Guide:
- guide/index.md
- Configuration: guide/configuration.md
- 配置指南: guide/configuration.md
- API:
- api/index.md
- Blog:
Expand Down
2 changes: 1 addition & 1 deletion src/gptui/_version.py
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
__title__ = "gptui"
__version__ = "0.5.2"
__version__ = "0.5.3"
2 changes: 1 addition & 1 deletion src/gptui/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ os:
# macos
# windows

default_plugins_used:
default_plugins_used: []
#% List of plugin's name of default used
#- WebServe

Expand Down

0 comments on commit e923cd6

Please sign in to comment.