Skip to content

Commit

Permalink
docs: update ChatHub references to ChatLuna
Browse files Browse the repository at this point in the history
- Replace 'chathub' with 'chatluna' in API calls and command examples
- Update sidebar links to reflect new ChatLuna naming
- Modify error code descriptions for ChatLuna
- Update preset system and useful commands documentation
  • Loading branch information
dingyi222666 committed Oct 6, 2024
1 parent 8287633 commit dba0c33
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 15 deletions.
12 changes: 6 additions & 6 deletions docs/.vitepress/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -335,7 +335,7 @@ function sidebarDevelopment(): DefaultTheme.SidebarItem[] {
},
{
text: '调用 ChatLuna API',
link: '/development/call-chathub-api',
link: '/development/call-chatluna-api',
},
],
},
Expand Down Expand Up @@ -391,15 +391,15 @@ function sidebarDevelopment(): DefaultTheme.SidebarItem[] {
items: [
{
text: 'ChatLuna 服务 (ChatLuna Service)',
link: '/development/api-reference/chathub-service',
link: '/development/api-reference/chatluna-service',
},
{
text: 'ChatLuna 中间件聊天链(ChatChain)',
link: '/development/api-reference/chathub-chat-chain',
link: '/development/api-reference/chatluna-chat-chain',
},
{
text: 'ChatLuna 插件(ChatLuna Plugin)',
link: '/development/api-reference/chathub-plugin',
link: '/development/api-reference/chatluna-plugin',
},
{
text: 'ChatLuna 大语言模型核心 (LLM Core)',
Expand Down Expand Up @@ -433,11 +433,11 @@ function sidebarDevelopment(): DefaultTheme.SidebarItem[] {
items: [
{
text: '日志 (logger)',
link: '/development/api-reference/chathub-utils/logger',
link: '/development/api-reference/chatluna-utils/logger',
},
{
text: '请求工具 (request)',
link: '/development/api-reference/chathub-utils/request',
link: '/development/api-reference/chatluna-utils/request',
},
],
},
Expand Down
4 changes: 2 additions & 2 deletions docs/guide/faq/error_code.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 错误码表

本节会将 ChatHub 里的常见错误码列出,并给出某些可能的解决方案。
本节会将 ChatLuna 里的常见错误码列出,并给出某些可能的解决方案。

:::warning
如果尝试了下面的解决方案后仍然无效,请联系开发者以解决问题(需要提供错误日志)。
Expand All @@ -10,7 +10,7 @@
|--------|-----------------------------|---------------------|
| 1 | 网络错误 | 检查代理配置,网络连接是否正常、 |
| 2 | 不支持的代理协议 | 检查代理配置,是否选择了正确的协议 (只支持 http/sock5) |
| 3 | 队列溢出 | 大量请求!难得 ChatHub 能被这么多人用呢。。 |
| 3 | 队列溢出 | 大量请求!难得 ChatLuna 能被这么多人用呢。。 |
| 4 | 渲染出错 | 根据房间的渲染模式,检查 Puppeteer 浏览器渲染配置,语音服务等 |
| 100 | API KEY 无效 | 检查 API KEY 是否可用。 |
| 101 | 请求时需要验证码 | 手动登录相关网页过验证码。 |
Expand Down
2 changes: 1 addition & 1 deletion docs/guide/preset-system/write-preset.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ format_user_prompt: "用户{sender}说: {prompt}"
也就是说,关键词属于预设文件的唯一标识符。
:::warning
请不要让不同预设文件里的关键词一致,这会导致关键词冲突。当使用冲突的关键词时,ChatHub 可能会返回任意一个使用了该关键词的预设(这很可能不会是你想要设置的目标预设)。
请不要让不同预设文件里的关键词一致,这会导致关键词冲突。当使用冲突的关键词时,ChatLuna 可能会返回任意一个使用了该关键词的预设(这很可能不会是你想要设置的目标预设)。
:::
### prompts
Expand Down
12 changes: 6 additions & 6 deletions docs/guide/useful-commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -539,7 +539,7 @@ Current date: {date}......<br/>
啊对了,近期我发现用可爱的语气与冒犯的语气相结合能够让我感觉更好。<br/>
所以说,用可爱和冒犯的语......<br/>

<br/>你可以使用 chathub.room.set -p &lt;preset&gt; 来设置默认使用的预设<br/>
<br/>你可以使用 chatluna.room.set -p &lt;preset&gt; 来设置默认使用的预设<br/>

<br/>当前为第 1 / 3 页
</chat-message>
Expand Down Expand Up @@ -924,7 +924,7 @@ chatluna.auth.add -u <user:user> <group:string>
以下为例子:

<chat-panel>
<chat-message nickname="User">chathub.auth.add guest -u @dingyi</chat-message>
<chat-message nickname="User">chatluna.auth.add guest -u @dingyi</chat-message>
<chat-message nickname="Bot">已将用户 0 添加到配额组 guest</chat-message>
</chat-panel>

Expand All @@ -939,7 +939,7 @@ chatluna.auth.add -u <user:user> <group:string>
以下为命令格式:

```sh
chathub.auth.kick -u <user:user> <group:name>
chatluna.auth.kick -u <user:user> <group:name>
```

以下为参数说明:
Expand All @@ -954,7 +954,7 @@ chathub.auth.kick -u <user:user> <group:name>
以下为例子:

<chat-panel>
<chat-message nickname="User">chathub.auth.kick guest -u @dingyi</chat-message>
<chat-message nickname="User">chatluna.auth.kick guest -u @dingyi</chat-message>
<chat-message nickname="Bot">已将用户 2371124484 踢出配额组 admin</chat-message>
</chat-panel>

Expand Down Expand Up @@ -987,7 +987,7 @@ chatluna.auth.create -n <name:string> -s [...model] -c <cost:number> -pm <preMin
下面我们只演示交互式创建的例子,其他的使用方法请自行摸索(或等待文档继续完善)

<chat-panel>
<chat-message nickname="User">chathub.auth.create -n 测试</chat-message>
<chat-message nickname="User">chatluna.auth.create -n 测试</chat-message>
<chat-message nickname="Bot">
你已经输入了配额组名:测试,是否需要更换?如需更换请回复更换后的配额组名,否则回复 N。
</chat-message>
Expand Down Expand Up @@ -1066,7 +1066,7 @@ chatluna.auth.list -l <limit:number> -p <page:number>
并发限制每 10 条消息/分<br/>
并发限制每 100 条消息/天<br/>

<br/>你可以使用 chathub.auth.add &lt;name/id&gt; 来加入某个配额组。<br/>
<br/>你可以使用 chatluna.auth.add &lt;name/id&gt; 来加入某个配额组。<br/>

<br/>当前为第 1 / 1 页<br/>
</chat-message>
Expand Down

0 comments on commit dba0c33

Please sign in to comment.