Skip to content

Commit

Permalink
docs: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
rockbenben committed Mar 13, 2024
1 parent 8c9ee19 commit a15517d
Show file tree
Hide file tree
Showing 30 changed files with 67 additions and 54 deletions.
2 changes: 1 addition & 1 deletion README-lang/README-ar.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@

### نشر باستخدام Vercel

[![Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Frockbenben%2FChatGPT-Shortcut%2Ftree%2Fgh-pages)
[![Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Frockbenben%2FChatGPT-Shortcut%2Ftree%2Fmain)

### التثبيت

Expand Down
2 changes: 1 addition & 1 deletion README-lang/README-bn.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ AiShort (ChatGPT Shortcut) ব্রাউজার এক্সটেনশন

### Vercel সহ ডিপ্লয় করুন

[![Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Frockbenben%2FChatGPT-Shortcut%2Ftree%2Fgh-pages)
[![Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Frockbenben%2FChatGPT-Shortcut%2Ftree%2Fmain)

### ইনস্টলেশন

Expand Down
2 changes: 1 addition & 1 deletion README-lang/README-de.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ Die AiShort (ChatGPT Shortcut) Browser-Erweiterung unterstützt Chrome und Edge

### Bereitstellung mit Vercel

[![Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Frockbenben%2FChatGPT-Shortcut%2Ftree%2Fgh-pages)
[![Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Frockbenben%2FChatGPT-Shortcut%2Ftree%2Fmain)

### Installation

Expand Down
2 changes: 1 addition & 1 deletion README-lang/README-es.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ La extensión del navegador AiShort (ChatGPT Shortcut) es compatible con Chrome

### Implementar con Vercel

[![Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Frockbenben%2FChatGPT-Shortcut%2Ftree%2Fgh-pages)
[![Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Frockbenben%2FChatGPT-Shortcut%2Ftree%2Fmain)

### Instalación

Expand Down
2 changes: 1 addition & 1 deletion README-lang/README-fr.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ L'extension de navigateur AiShort (ChatGPT Shortcut) prend en charge Chrome et E

### Déployer avec Vercel

[![Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Frockbenben%2FChatGPT-Shortcut%2Ftree%2Fgh-pages)
[![Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Frockbenben%2FChatGPT-Shortcut%2Ftree%2Fmain)

### Installation

Expand Down
2 changes: 1 addition & 1 deletion README-lang/README-hi.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ AiShort (ChatGPT Shortcut) ब्राउज़र एक्सटेंशन

### Vercel के साथ डिप्लॉय करें

[![Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Frockbenben%2FChatGPT-Shortcut%2Ftree%2Fgh-pages)
[![Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Frockbenben%2FChatGPT-Shortcut%2Ftree%2Fmain)

### स्थापना

Expand Down
2 changes: 1 addition & 1 deletion README-lang/README-it.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ L'estensione del browser AiShort (ChatGPT Shortcut) supporta Chrome e Edge con f

### Deploy con Vercel

[![Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Frockbenben%2FChatGPT-Shortcut%2Ftree%2Fgh-pages)
[![Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Frockbenben%2FChatGPT-Shortcut%2Ftree%2Fmain)

### Installazione

Expand Down
2 changes: 1 addition & 1 deletion README-lang/README-ja.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ AiShort(ChatGPT Shortcut)のブラウザエクステンションは、Chrome

### Vercel を用いたデプロイ

[![Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Frockbenben%2FChatGPT-Shortcut%2Ftree%2Fgh-pages)
[![Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Frockbenben%2FChatGPT-Shortcut%2Ftree%2Fmain)

### インストール

Expand Down
2 changes: 1 addition & 1 deletion README-lang/README-ko.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ AiShort (ChatGPT Shortcut) 브라우저 확장은 Chrome 과 Edge 를 지원하

### Vercel 을 통한 배포

[![Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Frockbenben%2FChatGPT-Shortcut%2Ftree%2Fgh-pages)
[![Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Frockbenben%2FChatGPT-Shortcut%2Ftree%2Fmain)

### 설치

Expand Down
2 changes: 1 addition & 1 deletion README-lang/README-pt.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ A extensão do navegador AiShort (ChatGPT Shortcut) suporta Chrome e Edge com fu

### Implantação com Vercel

[![Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Frockbenben%2FChatGPT-Shortcut%2Ftree%2Fgh-pages)
[![Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Frockbenben%2FChatGPT-Shortcut%2Ftree%2Fmain)

### Instalação

Expand Down
2 changes: 1 addition & 1 deletion README-lang/README-ru.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ AiShort предоставляет сжатый и простой в испол

### Развертывание с помощью Vercel

[![Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Frockbenben%2FChatGPT-Shortcut%2Ftree%2Fgh-pages)
[![Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Frockbenben%2FChatGPT-Shortcut%2Ftree%2Fmain)

### Установка

Expand Down
2 changes: 1 addition & 1 deletion README-zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ AiShort(ChatGPT Shortcut)扩展兼容 Chrome、Edge、Firefox 及其他基

### Deploy With Vercel

[![Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Frockbenben%2FChatGPT-Shortcut%2Ftree%2Fgh-pages)
[![Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Frockbenben%2FChatGPT-Shortcut%2Ftree%2Fmain)

### Installation

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ In addition, we offer the Tampermonkey script - [**ChatGPT Shortcut Anywhere**](

### Deploy With Vercel

[![Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Frockbenben%2FChatGPT-Shortcut%2Ftree%2Fgh-pages)
[![Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Frockbenben%2FChatGPT-Shortcut%2Ftree%2Fmain)

### Installation

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

## Deploy With Vercel

[![Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Frockbenben%2FChatGPT-Shortcut%2Ftree%2Fgh-pages)
[![Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Frockbenben%2FChatGPT-Shortcut%2Ftree%2Fmain)

## Installation

Expand Down
12 changes: 8 additions & 4 deletions docs/guides/community.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,21 @@
# 社区提示词

社群提示词版块将展示由网友分享和上传的自定义提示词。您可以将提示词分享到公开页面,同时也可以查看其他人分享的提示词以获取灵感
社区提示词版块展示的是由网友们分享和上传的自定义提示词。这一板块旨在鼓励创意的交流与灵感的碰撞,让每位用户都能在这里找到灵感,并分享自己独到的创意。您不仅可以将自己的提示词分享到公开页面,还可以浏览其他人分享的提示词,从中获取灵感

## 排序和投票

社区提示词页面提供发布时间、赞/踩投票排序和关键词搜索选项,您可以自由筛选社区提示词
社区提示词页面提供了发布时间、赞/踩投票排序以及关键词搜索等多种选项,方便用户自由地筛选和查找社区中的提示词

![](https://img.newzone.top/2023-07-13-14-50-15.png?imageMogr2/format/webp/thumbnail/500x)

赞/踩投票将决定主页上收录的提示词。目前仅限登录用户进行投票,对同一提示词的重复投票只记录最近一次。
赞/踩投票机制是用于决定哪些提示词会显示在主页的重要方式。这个机制旨在提升内容的质量和相关性,通过用户的直接参与筛选出社区认为有价值的提示词。对于那些被认为低质量的提示词,您可以通过**点踩来表达不满**。一旦某个提示词获得的踩数达到一定数量,它就会在公开页面上被隐藏,以确保展示给大家的都是高质量的内容。

投票功能仅对登录用户开放,以保证投票的真实性和有效性。每位用户对同一提示词的投票将以最近一次为准,确保了投票结果的准确反映用户当前的意见。

## 私密提示词

如果您希望保存私密提示词,提交或更新提示词时可以选择是否与社区分享
如果您有一些不想公开的创意或想法,社区也提供了私密提示词的选项。在提交或更新提示词时,您可以选择是否与社区分享。这样,您就可以在需要时保存私密提示词,同时也能在希望分享时与大家一起交流灵感

![](https://img.newzone.top/2023-07-13-09-13-00.gif?imageMogr2/format/webp/thumbnail/500x)

我们诚挚地邀请您积极分享自己的创意提示词,通过赞/踩投票机制共同维护社区内容的高质量。您的每一次参与和贡献都是推动社区不断成长和进步的关键力量。让我们一起创造一个充满创意、活力、并且彼此支持的提示词社区环境。
10 changes: 9 additions & 1 deletion docs/guides/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,17 @@ API 中可以将提示词设为「system prompt」,这样后续就不需要输

在网页版 ChatGPT 中,如果没有切换主提示词,只需用引号将后续回复内容框选即可,这样就不需要每次都输入提示词。当回复内容不符合提示词要求时,说明 ChatGPT 已经忘记了提示词,此时需要重新输入提示词以唤醒它。另外,每个对话的链接都是唯一的,你可以将常用的对话保存为书签,以便日后使用。

## GPTs 与提示词的区别

**GPTs** 功能允许用户通过定制的输入文本指令与模型进行交互。这些指令的目的是引导模型生成与用户需求紧密相关的输出。因此,这些 **GPTs 输入指令在功能上等同于提示词**

从应用实践来看,这些 GPTs 输入指令实质上充当了系统内置的提示词角色。它们不仅指引模型生成特定反应,也体现了用户对模型预期行为的控制与指导。实际上,社区中许多提示词都源于 **GPTs 内置指令**

## 输入法搜索延迟

搜索功能基于 Docusaurus 的 showcase,存在 PC 端输入法焦点丢失问题。向 Docusaurus 反馈后,对方表示会尝试修复和 `FWIW, you should not be using Chinese anyway, since the showcase is not localized`。但问题始终没有解决。因此,我将搜索组件分为移动端和 PC 端两类。移动端搜索逻辑保持不变,而屏幕宽度阈值 768px 以上的 PC 端浏览引入 `debounce` 函数解决输入法问题。但这在 PC 端产生两个问题:一是非英文输入需在 800 毫秒内完成;二是 PC 端搜索刷新从即时变为 800 毫秒延迟。若你有更好的解决方案,欢迎提供反馈。
AI Short 网页版通过手动搜索实现无延迟搜索,而 Docker 或扩展版本采用自动搜索,存在 800 毫秒的延迟。

此问题源于扩展搜索功能基于 Docusaurus 的 showcase,存在 PC 端输入法焦点丢失问题。向 Docusaurus 反馈后,对方表示会尝试修复和 `FWIW, you should not be using Chinese anyway, since the showcase is not localized`。但问题始终没有解决。因此,我将搜索组件分为移动端和 PC 端两类。移动端搜索逻辑保持不变,而屏幕宽度阈值 768px 以上的 PC 端浏览引入 `debounce` 函数解决输入法问题。但这在 PC 端产生两个问题:一是非英文输入需在 800 毫秒内完成;二是 PC 端搜索刷新从即时变为 800 毫秒延迟。若你有更好的解决方案,欢迎提供反馈。

## 输出虚假信息

Expand Down
20 changes: 12 additions & 8 deletions docs/guides/getting-started.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,39 @@
# 开始上手

AiShort 页面默认显示全部的提示词,页面分为标签区、搜索区和提示词展示区
AiShort 页面为用户提供了一个直观的界面来浏览和筛选提示词,以便找到最适合自己需求的内容。页面主要由标签区、搜索区和提示词展示区三部分组成,旨在为用户提供一个高效、直观的搜索体验

![image](https://user-images.githubusercontent.com/28252913/222007639-20148284-8366-427f-9ee7-ad1be0edbd2e.png)
![](https://img.newzone.top/2024-03-07-04-56-01.png?imageMogr2/format/webp)

## 🏷︎ 标签筛选

标签区按提示词的领域和功能进行划分,可根据不同场景和需求进行选择。与标签区右上方的「标签筛选规则切换」按钮配合使用,可进行多标签筛选。默认状态为 OR,即选中标签下的所有提示词。切换到 AND 后,将筛选出具备已选中的多个标签的提示词
标签区便于用户根据提示词的领域和功能进行筛选,满足不同的场景和需求。通过右上方的「标签筛选规则切换」按钮,用户可以实现更精细的多标签筛选。默认的筛选规则为 OR,即展示选中任一标签下的提示词。切换至 AND 规则时,则仅展示同时具备所有选中标签的提示词

![](https://img.newzone.top/2023-02-28-10-31-01.png?imageMogr2/format/webp)

## 🔍 关键词搜索

关键词搜索范围包括提示词的标题、简介、内容和你的母语翻译。输入关键词后,提示词展示区将立即展示筛选出的内容。如果已选中标签,则关键词搜索仅限于标签筛选范围内。对于 PC 端,搜索框内容变化后,新的搜索结果会在 800 毫秒后显示。移动端则为即时刷新。

关键词搜索功能支持用户对提示词的标题、简介、内容及其母语翻译进行搜索。输入关键词后,展示区会即时更新以显示符合条件的提示词。如果已有标签选中,搜索范围则限定在这些标签下。在 PC 端,搜索结果会在输入停止后 800 毫秒刷新;而移动端则支持即时刷新。

![](https://img.newzone.top/2023-02-28-10-31-10.png?imageMogr2/format/webp)

## 🔬 展示区复制

通过标签筛选和关键词搜索,点击卡片右上方的「复制」按钮即可获取提示词。将其粘贴到 ChatGPT 中后,参考提示调整需求文本,即可得到指定领域的回复。如果提示词中的母语备注没有解释清楚,可以点击提示词的右下方链接查看来源网页
在经过标签筛选和关键词搜索后,点击提示词卡片右上方的「复制」按钮,即可获取所需的提示词。将这些提示词粘贴到 ChatGPT 或相应的模型界面中,即可针对特定领域获取回复。若提示词的母语备注未能清晰说明,用户可通过点击卡片右下方的链接查看原始网页以获得更多信息

![](https://img.newzone.top/2023-06-11-17-10-37.png?imageMogr2/format/webp)

## 💬 语言切换

默认情况下,提示词内容以英文显示。如果你使用的是非英文页面,若要查看您的母语释义,请点击提示词内容切换至非英文,再次点击即可切回英文。请注意,语言切换只在 Prompt 文字上的点击有效,点击空白区域无效
默认情况下,提示词内容以英文展示。对于使用非英文界面的用户,可以通过点击提示词内容来切换至母语释义,再次点击则可切回英文。请注意,语言切换功能仅对提示词文本区域的点击有效

![中英文切换](http://img.newzone.top/chatgptshortcut_encn.gif)
![中英文切换](https://img.newzone.top/chatgptshortcut_encn.gif)

如果想让提示词默认显示为你的母语,你可以点击标签区右上方的 `切换 Prompt 语言` 按钮。需要注意的是,即使切换到母语翻译,复制按钮也仅针对英文提示词复制
若希望提示词默认以您的母语显示,可点击标签区右上方的 `切换 Prompt 语言` 按钮进行设置。需要注意,即使在母语界面,复制功能依然只针对英文提示词

## 🔥 热门排序

现在页面会显示 Prompt 的使用次数,使用次数排名靠前的 Prompt 将会被标记为「favorite」。同时,Prompt 的标签排序也将以热力值为主。热力值将会定期更新。
页面将根据提示词的使用次数进行排序,以帮助用户快速发现当前最受欢迎的提示词。

提示词的标签排序也会根据其热度值进行调整,而这些热度值会定期更新,以确保反映出社区的最新偏好和趋势。
Loading

0 comments on commit a15517d

Please sign in to comment.