Fix issues from reivew

limitx0 · limitx0 · commit 8d984243a220 · 2025-06-01T23:02:45.000+08:00
- Fix issues from Copilot's review
- Fix issues from CodeRabbit's review

- Fix issue from PeterDaveHello's review
  - Use relative paths

  - Revert unrelated modification
diff --git a/CONTRIBUTION.md b/CONTRIBUTION.md
@@ -91,7 +91,7 @@ If you would like to add a new AI bot to ChatALL, please follow these steps:
    }
    ```
 
-For detailed bot development documentation, see [developing_bot.md](https://github.com/ai-shifu/ChatALL/blob/main/doc/developing_bot.md).
+For detailed bot development documentation, see [docs/developing_bot.md](docs/developing_bot.md).
 
 ### Basic Bot Implementation Example
 
diff --git a/README.md b/README.md
@@ -155,7 +155,7 @@ If the problem persists, please [submit an issue](https://github.com/ai-shifu/Ch
 
 ### Contribute a Bot
 
-[The guide](https://github.com/ai-shifu/ChatALL/blob/main/doc/developing_bot.md) may help you.
+[The guide](docs/developing_bot.md) may help you.
 
 ### Run
 
diff --git a/README_DE-DE.md b/README_DE-DE.md
@@ -155,7 +155,7 @@ Wenn das Problem weiterhin besteht, [reichen Sie ein Issue ein](https://github.c
 
 ### Einen Bot beisteuern
 
-[Die Anleitung](https://github.com/ai-shifu/ChatALL/blob/main/doc/developing_bot.md) hilft dir dabei.
+[Die Anleitung](docs/developing_bot.md) hilft dir dabei.
 
 ### Ausführen
 
diff --git a/README_ES-ES.md b/README_ES-ES.md
@@ -155,7 +155,7 @@ Si el problema persiste, [envíe un problema](https://github.com/ai-shifu/ChatAL
 
 ### Contribuir con un bot
 
-[La guía](https://github.com/ai-shifu/ChatALL/blob/main/doc/developing_bot.md) puede ayudarle.
+[La guía](docs/developing_bot.md) puede ayudarle.
 
 ### Correr
 
diff --git a/README_FR-FR.md b/README_FR-FR.md
@@ -155,7 +155,7 @@ Si le problème persiste, veuillez [soumettre un problème](https://github.com/a
 
 ### Contribuer à un bot
 
-[Le guide](https://github.com/ai-shifu/ChatALL/blob/main/doc/developing_bot.md) may help you.
+[Le guide](docs/developing_bot.md) peut vous aider.
 
 ### Lancement
 
diff --git a/README_IT-IT.md b/README_IT-IT.md
@@ -155,7 +155,7 @@ Se il problema persiste, per favore [segnala il problema](https://github.com/ai-
 
 ### Contribuisci con un Bot
 
-[Guida](https://github.com/ai-shifu/ChatALL/blob/main/doc/developing_bot.md) potrebbe esserti utile.
+[Guida](docs/developing_bot.md) potrebbe esserti utile.
 
 ### Esegui
 
diff --git a/README_JA-JP.md b/README_JA-JP.md
@@ -155,7 +155,7 @@ ChatALLを初期化するには、以下のディレクトリを削除します
 
 ### AIの提供
 
-[ガイド](https://github.com/ai-shifu/ChatALL/blob/main/doc/developing_bot.md)を参考にしてください。
+[ガイド](docs/developing_bot.md)を参考にしてください。
 
 ### 実行
 
diff --git a/README_KO-KR.md b/README_KO-KR.md
@@ -155,7 +155,7 @@ ChatALL을 사용하는 동안 문제가 발생하면 다음 방법을 사용하
 
 ### 봇 기부
 
-[가이드](https://github.com/ai-shifu/ChatALL/blob/main/doc/developing_bot.md)가 도움이 될 수 있습니다.
+[가이드](docs/developing_bot.md)가 도움이 될 수 있습니다.
 
 ### 실행
 
diff --git a/README_RU-RU.md b/README_RU-RU.md
@@ -155,7 +155,7 @@ brew install --cask chatall
 
 ### Сделать бота
 
-[Этот гайд](https://github.com/ai-shifu/ChatALL/blob/main/doc/developing_bot.md) может помочь вам.
+[Этот гайд](docs/developing_bot.md) может помочь вам.
 
 ### Запуск
 
diff --git a/README_VI-VN.md b/README_VI-VN.md
@@ -155,7 +155,7 @@ Nếu vấn đề vẫn tiếp tục, vui lòng [gửi issue](https://github.com
 
 ### Đóng góp Bot
 
-[Hướng dẫn](https://github.com/ai-shifu/ChatALL/blob/main/doc/developing_bot.md) này sẽ giúp bạn.
+[Hướng dẫn](docs/developing_bot.md) này sẽ giúp bạn.
 
 ### Chạy thử
 
diff --git a/README_ZH-CN.md b/README_ZH-CN.md
@@ -155,7 +155,7 @@ brew install --cask chatall
 
 ### 贡献新的 AI 机器人
 
-[这份文档](https://github.com/ai-shifu/ChatALL/blob/main/doc/developing_bot.md)能提供一些帮助。
+[这份文档](docs/developing_bot.md)能提供一些帮助。
 
 ### Run
 
diff --git a/docs/developing_bot.md b/docs/developing_bot.md
@@ -1,7 +1,8 @@
 # Developing Bots for ChatALL
 
 ## Quick Start
-- [Basic bot setup](https://github.com/ai-shifu/ChatALL/blob/main/CONTRIBUTION.md#adding-a-new-ai-bot)
+
+See [Adding a new AI bot](../CONTRIBUTION.md#adding-a-new-ai-bot) in `CONTRIBUTION.md`.
 
 ## Advanced Topics  
 
@@ -49,105 +50,33 @@ const all = [
 
 ### Setting component implementation
 
-To fulfill other core functions, you need login functionality, API key configuration, etc. If your bot does not require login or you don't mind putting the key directly in the code (strongly not recommended), you can skip this section.
+To fulfill other core functions, you need login functionality, API key configuration, etc. If your bot does not require login, or you don't mind putting the key directly in the code (strongly not recommended), you can skip this section.
 
 #### Create a settings component
 
 
 In the `src/components/BotSettings/` directory, create a new file named `KnowNothingBotSettings.vue`. 
-\
+
 You can use existing settings components as templates: 
 
 1. If you only need login functionality, just copy `BardBotSettings.vue` and change import Bot from `@/bots/BardBot;` to import Bot from `@/bots/KnowNothingBot;`. 
    - (Note: Some websites have implemented security measures to prevent ChatALL and similar clients from accessing them. If you encounter such situations, you will need to do a lot of hack work.)
 2. If you only need to configure the API key, copy `WenxinQianfanBotSettings.vue` and modify it, but this will require more work.
-3. For complex settings with multiple configurations, you will need to do even more work. 
+3. Complex setups with multiple configuration options require additional implementation steps.
 
 #### Add settings field
 
 ChatALL's settings UI is built using [Vuetify 3](https://vuetifyjs.com/). 
 Refer to the [Vuetify 3 official documentation](https://vuetifyjs.com/en/introduction/why-vuetify/) to see and test the rich components it supports. 
-\
-By referring to the existing code, you can basically get everything workin. No need for further explanation here.
+
+By reviewing the existing implementation, you can adapt the code to suit your bot’s settings.
 
 ChatALL's settings are stored in local storage using the [`vuex-persist`](https://github.com/championswimmer/vuex-persist). It's very handy, though the documentation is not readable enough. 
 Here is a brief introduction on how to use it: 
 
 First, in `src/store/index.js`, add the following code: 
 
-```JavaScript
-export default createStore({
-  state: {
-    ...
-    knowNothing: {
-      setting1: "",
-      setting2: "",
-    },
-    ...
-  },
-  mutations: {
-    ...
-    setKnowNothing(state, { setting1, setting2 }) {
-      state.knowNothing = { setting1, setting2 };
-    },
-    ...
-  },
-  ...
-});
-```
-
-`setting1`, `setting2`, and sub-objects can be added, deleted, or modified as you like. Just make sure the top-level object is `knowNothing`, even if it only has one configuration. 
-
-Then, in `KnowNothingBotSettings.vue`, add the following code: 
-
-```JavaScript
-export default {
-  ...
-  methods: {
-    ...mapMutations(["setKnowNothing"]),
-    setSetting1(value){
-      this.setKnowNothing({
-        ...this.knowNothing,
-        setting1: value
-      })
-    },
-    setSetting2(value){
-      this.setKnowNothing({
-        ...this.knowNothing,
-        setting2: value
-      })
-    },
-  },
-  computed: {
-    ...mapState(["knowNothing"])
-  }
-}
-```
-
-Finally, bind the `v-model` of the Vuetify component to the corresponding `knowNothing.xxx`, and point the action to the corresponding `setXxx()` function. For example: 
-
-```HTML
-<v-text-field
-  v-model="knowNothing.setting1"
-  @change="setSetting1($event.target.value)"
-></v-text-field>
-```
-
-Done! Run the program and open DevTools to check if the values are correctly stored in the "Application" tab. 
-
-In `KnowNothingBot.js`, using the parameters you set is very simple:
-
-```JavaScript
-...
-import store from "@/store";
-...
-store.state.knowNothing.setting1
-store.state.knowNothing.setting2
-const { setting1, setting2 } = store.state.knowNothing;
-...
-```
-
-```JavaScript
+```javascript
 export default createStore({
   state: {
     ...
@@ -172,7 +101,7 @@ export default createStore({
 
 Then, in `KnowNothingBotSettings.vue`, add the following code: 
 
-```JavaScript
+```javascript
 export default {
   ...
   methods: {
@@ -198,18 +127,18 @@ export default {
 
 Finally, bind the `v-model` of the Vuetify component to the corresponding `knowNothing.xxx`, and point the action to the corresponding `setXxx()` function. For example: 
 
-```HTML
+```html
 <v-text-field
   v-model="knowNothing.setting1"
-  @change="setSetting1($event.target.value)"
+  @update:model-value="setSetting1"
 ></v-text-field>
 ```
 
 Done! Run the program and open DevTools to check if the values are correctly stored in the "Application" tab. 
 
-In `KnowNothingBot.js`, using the parameters you set is very simple:
+In `KnowNothingBot.js`, using the parameters you set is straightforward:
 
-```JavaScript
+```javascript
 ...
 import store from "@/store";
 ...
@@ -231,11 +160,10 @@ Reference existing bots depending on your interface type:
 
 How you send and parse messages depends on the specific chatbot. Once you receive a response or hit an error, do the following: 
 
-1. When receiving partial text, call `onUpdateResponse(callbackParam, {});`. 
-2. If the response only contains new incremental text, and you need to assemble all the text yourself, then call `onUpdateResponse(callbackParam, {content: text, done: false)};`. 
-3. After receiving all the text, call `onUpdateResponse(callbackParam, {content: text, done: true)};` to update all the data. If the text has already been `onUpdateResponse` before, you can just call `onUpdateResponse(callbackParam, {done: true)};`. 
-4. When ending normally, call `resolve()`. 
-5. If an error occurs, call `reject(error)`. The `error` can be an exception or an error message string. ChatALL will automatically handle it and display it to the user. 
+1. If the response only contains new incremental text, and you need to assemble all the text yourself, then call `onUpdateResponse(callbackParam, { content: text, done: false });`. 
+2. After receiving all the text, call `onUpdateResponse(callbackParam, { content: text, done: true });` to update all the data. If the text has already been `onUpdateResponse` before, you can just call `onUpdateResponse(callbackParam, { done: true });`. 
+3. When ending normally, call `resolve()`. 
+4. If an error occurs, call `reject(error)`. The `error` can be an exception or an error message string. ChatALL will automatically handle it and display it to the user. 
 
 ### checkAvailability() implementation
 
@@ -249,27 +177,27 @@ In general, it performs these checks:
 
 If everything is good, it should execute:
 
-```JavaScript
+```javascript
 this.constructor._isAvailable = true;
 ```
 
 Otherwise, it should execute:
 
-```JavaScript
+```javascript
 this.constructor._isAvailable = false;
 ```
 
 Finally, always do:
 
-```JavaScript
+```javascript
 return this.isAvailable();
 ```
 
 ### Custom bot icons
 
 Place the icon file in `src/assets/bots/knownothing-logo.png`, and modify `KnowNothingBot.js`:
 
-```JavaScript
+```javascript
 static _logoFilename = "knownothing-logo.png";
 ```
 
@@ -280,23 +208,31 @@ You need to add at least the following for your bot:
 
 `en.json`
 ```json
+{
+    ...
     "knowNothing": {
         "name": "Know Nothing"
     },
+    ...
+}
 ```
 
 `zh.json`
 ```json
+{
+    ...
     "knowNothing": {
         "name": "啥都不懂"
     },
+    ...
+}
 ```
 
-Plus any other strings your bot need.
+Plus any other strings your bot needs.
 
 In JavaScript, you can use the following code to call the multi-language support:
 
-```JavaScript
+```javascript
 import i18n from "@/i18n";
 ...
 i18n.global.t("knowNothing.stringName")
@@ -305,6 +241,6 @@ i18n.global.t("knowNothing.stringName")
 
 In HTML, you can use the following code:
 
-```HTML
+```html
 {{ $t("knowNothing.stringName") }}
 ```

Original file line number	Diff line number	Diff line change
`@@ -91,7 +91,7 @@ If you would like to add a new AI bot to ChatALL, please follow these steps:`
`91`	`91`	`}`
`92`	`92`	```
`93`	`93`
`94`		`-For detailed bot development documentation, see [developing_bot.md](https://github.com/ai-shifu/ChatALL/blob/main/doc/developing_bot.md).`
	`94`	`+For detailed bot development documentation, see [docs/developing_bot.md](docs/developing_bot.md).`
`95`	`95`
`96`	`96`	`### Basic Bot Implementation Example`
`97`	`97`