Skip to content

Commit 7ef20f2

Browse files
committed
doc: update docs
1 parent ace3f7f commit 7ef20f2

File tree

6 files changed

+17
-13
lines changed

6 files changed

+17
-13
lines changed

.github/ISSUE_TEMPLATE/反馈问题.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,10 @@ assignees: ''
1111

1212
⚠️ 注意:不遵循此模板的任何帖子都会被立即关闭。
1313

14-
> 请在下方中括号内输入 x 来表示你已经知晓相关内容。
14+
请在下方中括号内输入 x 来表示你已经知晓相关内容。
1515
- [ ] 我确认已经在 [常见问题](https://github.com/Yidadaa/ChatGPT-Next-Web/blob/main/docs/faq-cn.md) 中搜索了此次反馈的问题,没有找到解答;
1616
- [ ] 我确认已经在 [Issues](https://github.com/Yidadaa/ChatGPT-Next-Web/issues) 列表(包括已经 Close 的)中搜索了此次反馈的问题,没有找到解答。
17+
- [ ] 我确认已经在 [Vercel 使用教程](https://github.com/Yidadaa/ChatGPT-Next-Web/blob/main/docs/vercel-cn.md) 中搜索了此次反馈的问题,没有找到解答。
1718

1819
**描述问题**
1920
请在此描述你遇到了什么问题。

README.md

+14-2
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ One-Click to deploy well-designed ChatGPT web UI on Vercel.
2828
- Privacy first, all data stored locally in the browser
2929
- Responsive design, dark mode and PWA
3030
- Fast first screen loading speed (~100kb), support streaming response
31+
- New in v2: create, share and debug your chat tools with prompt templates (mask)
3132
- Awesome prompts powered by [awesome-chatgpt-prompts-zh](https://github.com/PlexPt/awesome-chatgpt-prompts-zh) and [awesome-chatgpt-prompts](https://github.com/f/awesome-chatgpt-prompts)
3233
- Automatically compresses chat history to support long conversations while also saving your tokens
3334
- One-click export all chat history with full Markdown support
@@ -37,7 +38,7 @@ One-Click to deploy well-designed ChatGPT web UI on Vercel.
3738

3839
- [x] System Prompt: pin a user defined prompt as system prompt [#138](https://github.com/Yidadaa/ChatGPT-Next-Web/issues/138)
3940
- [x] User Prompt: user can edit and save custom prompts to prompt list
40-
- [ ] Prompt Template: create a new chat with pre-defined in-context prompts
41+
- [x] Prompt Template: create a new chat with pre-defined in-context prompts [#993](https://github.com/Yidadaa/ChatGPT-Next-Web/issues/993)
4142
- [ ] Share as image, share to ShareGPT
4243
- [ ] Desktop App with tauri
4344
- [ ] Self-host Model: support llama, alpaca, ChatGLM, BELLE etc.
@@ -48,12 +49,16 @@ One-Click to deploy well-designed ChatGPT web UI on Vercel.
4849
- User login, accounts, cloud sync
4950
- UI text customize
5051

52+
## What's New
53+
- 🚀 v2.0 is released, now you can create prompt templates, turn your ideas into reality! Read this: [ChatGPT Prompt Engineering Tips: Zero, One and Few Shot Prompting](https://www.allabtai.com/prompt-engineering-tips-zero-one-and-few-shot-prompting/).
54+
5155
## 主要功能
5256

5357
- 在 1 分钟内使用 Vercel **免费一键部署**
5458
- 精心设计的 UI,响应式设计,支持深色模式,支持 PWA
5559
- 极快的首屏加载速度(~100kb),支持流式响应
5660
- 隐私安全,所有数据保存在用户浏览器本地
61+
- 预制角色功能(面具),方便地创建、分享和调试你的个性化对话
5762
- 海量的内置 prompt 列表,来自[中文](https://github.com/PlexPt/awesome-chatgpt-prompts-zh)[英文](https://github.com/f/awesome-chatgpt-prompts)
5863
- 自动压缩上下文聊天记录,在节省 Token 的同时支持超长对话
5964
- 一键导出聊天记录,完整的 Markdown 支持
@@ -63,7 +68,7 @@ One-Click to deploy well-designed ChatGPT web UI on Vercel.
6368

6469
- [x] 为每个对话设置系统 Prompt [#138](https://github.com/Yidadaa/ChatGPT-Next-Web/issues/138)
6570
- [x] 允许用户自行编辑内置 Prompt 列表
66-
- [ ] 提示词模板:使用预制上下文快速定制新对话
71+
- [x] 预制角色:使用预制角色快速定制新对话 [#993](https://github.com/Yidadaa/ChatGPT-Next-Web/issues/993)
6772
- [ ] 分享为图片,分享到 ShareGPT
6873
- [ ] 使用 tauri 打包桌面应用
6974
- [ ] 支持自部署的大语言模型
@@ -74,6 +79,11 @@ One-Click to deploy well-designed ChatGPT web UI on Vercel.
7479
- 界面文字自定义
7580
- 用户登录、账号管理、消息云同步
7681

82+
## 最新动态
83+
- 🚀 v2.0 已经发布,现在你可以使用面具功能快速创建预制对话了! 了解更多: [ChatGPT 提示词高阶技能:零次、一次和少样本提示](https://github.com/Yidadaa/ChatGPT-Next-Web/issues/138)
84+
85+
86+
7787
## Get Started
7888

7989
> [简体中文 > 如何开始使用](./README_CN.md#开始使用)
@@ -103,6 +113,8 @@ We recommend that you follow the steps below to re-deploy:
103113

104114
### Enable Automatic Updates
105115

116+
> If you encounter a failure of Upstream Sync execution, please manually sync fork once.
117+
106118
After forking the project, due to the limitations imposed by GitHub, you need to manually enable Workflows and Upstream Sync Action on the Actions page of the forked project. Once enabled, automatic updates will be scheduled every hour:
107119

108120
![Automatic Updates](./docs/images/enable-actions.jpg)

README_CN.md

+1-10
Original file line numberDiff line numberDiff line change
@@ -15,16 +15,6 @@
1515

1616
</div>
1717

18-
## 主要功能
19-
20-
- 在 1 分钟内使用 Vercel **免费一键部署**
21-
- 精心设计的 UI,响应式设计,支持深色模式
22-
- 极快的首屏加载速度(~100kb)
23-
- 海量的内置 prompt 列表,来自[中文](https://github.com/PlexPt/awesome-chatgpt-prompts-zh)[英文](https://github.com/f/awesome-chatgpt-prompts)
24-
- 自动压缩上下文聊天记录,在节省 Token 的同时支持超长对话
25-
- 一键导出聊天记录,完整的 Markdown 支持
26-
- 拥有自己的域名?好上加好,绑定后即可在任何地方**无障碍**快速访问
27-
2818
## 开始使用
2919

3020
1. 准备好你的 [OpenAI API Key](https://platform.openai.com/account/api-keys);
@@ -43,6 +33,7 @@
4333
- 在 Vercel 重新选择并部署,[请查看详细教程](./docs/vercel-cn.md#如何新建项目)
4434

4535
### 打开自动更新
36+
> 如果你遇到了 Upstream Sync 执行错误,请手动 Sync Fork 一次!
4637
4738
当你 fork 项目之后,由于 Github 的限制,需要手动去你 fork 后的项目的 Actions 页面启用 Workflows,并启用 Upstream Sync Action,启用之后即可开启每小时定时自动更新:
4839

docs/images/cover.png

-263 KB
Loading

docs/images/more.png

-210 KB
Loading

docs/images/settings.png

-90.2 KB
Loading

0 commit comments

Comments
 (0)