From 3e17647a7a354a0cff6cef598e2f88532aadb294 Mon Sep 17 00:00:00 2001 From: Kuingsmile Date: Wed, 6 Mar 2024 09:21:58 +0800 Subject: [PATCH] :pencil: Docs(custom): update FAQ --- CONTRIBUTING.md | 9 ++------- CONTRIBUTING_EN.md | 7 +------ FAQ.md | 2 +- FAQ_EN.md | 11 ++++++----- 4 files changed, 10 insertions(+), 19 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 07e7a78..6fef5f4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -17,22 +17,17 @@ yarn dev 启动项目。 2. 只跟 Electron 主进程相关的代码请在 `src/main` 目录下添加。只跟渲染进程相关的代码请在 `src/renderer` 目录下添加。两个进程都能使用的代码请在 `src/universal` 目录下添加。 **注意**：渲染进程没有 `Node.js` 能力，所有渲染进程需要用到 `Node.js` 模块相关的代码请在 `src/main/events/picgoCoreIPC.ts` 下添加事件进行处理。 - 3. 所有的跨进程事件名请在 `src/universal/events/constants.ts` 里添加。 - 4. 所有的全局类型定义请在 `src/universal/types/` 里添加，如果是 `enum`，请在 `src/universal/types/enum.ts` 里添加。 - -5. 与图床管理功能相关的代码请在`src/main/manage`和`src/renderer/manage`目录下添加。 +5. 与图床管理功能相关的代码请在 `src/main/manage`和 `src/renderer/manage`目录下添加。 ## i18n 1. 在 `public/i18n/` 下面创建一种语言的 `yml` 文件，例如 `zh-Hans.yml`。然后参考 `zh-CN.yml` 或者 `en.yml` 编写语言文件。并注意，PicList 会通过语言文件中的 `LANG_DISPLAY_LABEL` 向用户展示该语言的名称。 - 2. 在 `src/universal/i18n/index.ts` 里添加一种默认语言。其中 `label` 就是语言文件中 `LANG_DISPLAY_LABEL` 的值，`value` 是语言文件名。 - 3. 如果是对已有语言文件进行更新，请在更新完，务必运行一遍 `yarn gen-i18n`，确保能生成正确的语言定义文件。 ## 提交代码 1. 请检查代码没有多余的注释、`console.log` 等调试代码。 -2. 提交代码前，请执行命令 `git add . && yarn cz`，唤起 PicGo 的[代码提交规范工具](https://github.com/PicGo/bump-version)。通过该工具提交代码。 +2. 提交代码前，请执行命令 `git add . && yarn cz`，唤起 [代码提交规范工具](https://github.com/PicGo/bump-version)。通过该工具提交代码。 diff --git a/CONTRIBUTING_EN.md b/CONTRIBUTING_EN.md index df17415..d860d41 100644 --- a/CONTRIBUTING_EN.md +++ b/CONTRIBUTING_EN.md @@ -17,22 +17,17 @@ yarn dev Startup project. 2. Please add code only related to the main process of Electron in the `src/main` directory. Code only related to the rendering process should be added in the `src/renderer` directory. Add code that can be used by both processes in the `src/universal` directory. **Note**: The rendering process does not have the `Node.js` capability. All rendering processes need to use `Node.js modules` related code, please add events under `src/main/events/picgoCoreIPC.ts` for processing. - 3. Please add all cross-process event names in `src/universal/events/constants.ts`. - 4. Please add all global type definitions in `src/universal/types/`, if it is `enum`, please add it in `src/universal/types/enum.ts`. - 5. Code related to the management function of the picture bed should be added in the `src/main/manage` and `src/renderer/manage` directory. ## i18n 1. Create a language `yml` file under `public/i18n/`, for example `zh-Hans.yml`. Then refer to `zh-CN.yml` or `en.yml` to write language files. Also note that PicList will display the name of the language to the user via `LANG_DISPLAY_LABEL` in the language file. - 2. Add a default language to `src/universal/i18n/index.ts`. where `label` is the value of `LANG_DISPLAY_LABEL` in the language file, and `value` is the name of the language file. - 3. If you are updating an existing language file, be sure to run `yarn gen-i18n` after the update to ensure that the correct language definition file can be generated. ## Submit code 1. Please check that the code has no extra comments, `console.log` and other debugging code. -2. Before submitting the code, please execute the command `git add . && yarn cz` to invoke PicGo's [Code Submission Specification Tool](https://github.com/PicGo/bump-version). Submit code through this tool. +2. Before submitting the code, please execute the command `git add . && yarn cz` to invoke [Code Submission Specification Tool](https://github.com/PicGo/bump-version). Submit code through this tool. diff --git a/FAQ.md b/FAQ.md index e3088e5..313553d 100644 --- a/FAQ.md +++ b/FAQ.md @@ -4,7 +4,7 @@ ## 常见问题 -> 本软件的上传工具部分来自PicGo，基本没有改动，请参考PicGo的 [使用文档](https://picgo.github.io/PicGo-Doc/zh/guide/getting-started.html#%E5%BF%AB%E9%80%9F%E4%B8%8A%E6%89%8B) +> 常规配置问题请参考 [官方文档](https://piclist.cn) ## 1. PicList和PicGo有什么关系？ diff --git a/FAQ_EN.md b/FAQ_EN.md index bbed118..12785db 100644 --- a/FAQ_EN.md +++ b/FAQ_EN.md @@ -4,7 +4,7 @@ This FAQ has been modified from PicGo's FAQ, and thanks to the author Molunerfin ## Common Questions -> The upload tool of this software is mainly derived from PicGo, with minimal changes. Please refer to PicGo's [user manual](https://picgo.github.io/PicGo-Doc/zh/guide/getting-started.html#%E5%BF%AB%E9%80%9F%E4%B8%8A%E6%89%8B) for more information. +> Please refer to [user manual](https://piclist.cn) for general configuration issues. ## 1. What is the relationship between PicList and PicGo? @@ -79,17 +79,18 @@ Or right-click the PicList icon in the dock and select "Open Main Window." 1. PicList 自带的图床都经过测试，上传出错一般都不是 PicList 自身的原因。如果你用的是 GitHub 图床请参考上面的第 7 点。 2. 检查 PicList 的日志（报错日志可以在 PicList 设置 -> 设置日志文件 -> 点击打开 后找到），看看 `[PicList Error]` 的报错信息里有什么关键信息 + 1. 先自行搜索 error 里的报错信息，往往你能百度或者谷歌出问题原因，不必开 issue。 2. 如果有带有 `401` 、`403` 等 `40X` 状态码字样的，不用怀疑，就是你配置写错了，仔细检查配置，看看是否多了空格之类的。 3. 如果带有 `HttpError`、`RequestError` 、 `socket hang up` 等字样的说明这是网络问题，我无法帮你解决网络问题，请检查你自己的网络，是否有代理，DNS 设置是否正常等。 3. 通常网络问题引起的上传失败都是因为代理设置不当导致的。如果开启了系统代理，建议同时也在 PicList 的代理设置中设置对应的HTTP代理。 +4. PicList's built-in image hosting platforms have been tested, and upload errors are generally not caused by PicList itself. If you are using the GitHub image hosting platform, please refer to the 7th point above. +5. Check PicList's log (the error log can be found by clicking "Open" in PicList Settings -> Set Log File ->), and see if there is any key information in the `[PicList Error]` error message -1. PicList's built-in image hosting platforms have been tested, and upload errors are generally not caused by PicList itself. If you are using the GitHub image hosting platform, please refer to the 7th point above. -2. Check PicList's log (the error log can be found by clicking "Open" in PicList Settings -> Set Log File ->), and see if there is any key information in the `[PicList Error]` error message 1. First search for the error message in the error message by yourself, and you can often Baidu or Google the cause of the problem, so you don't need to open an issue. 2. If there are `401`, `403` and other `40X` status code words, don't doubt it, it means that your configuration is wrong, check the configuration carefully to see if there are extra spaces, etc. 3. If there are words such as `HttpError`, `RequestError`, `socket hang up`, etc., it means that this is a network problem, and I cannot help you solve the network problem. Please check your own network, whether there is a proxy, whether the DNS setting is normal, etc. -3. Usually, upload failures caused by network problems are caused by improper proxy settings. If the system proxy is turned on, it is recommended to set the corresponding HTTP proxy in the proxy settings of PicList at the same time. +6. Usually, upload failures caused by network problems are caused by improper proxy settings. If the system proxy is turned on, it is recommended to set the corresponding HTTP proxy in the proxy settings of PicList at the same time. ## 10. After installing the macOS version, there is no main interface @@ -170,4 +171,4 @@ Then run: ```bash docker-compose up -d -``` \ No newline at end of file +```