From 72a97ebd3e15b5a9eb3e5069c48bf80b5493806d Mon Sep 17 00:00:00 2001 From: Masterain Date: Sat, 16 Sep 2023 22:48:39 -0700 Subject: [PATCH] Update docs --- docs/.vuepress/theme.ts | 3 ++- docs/en/advanced/FAQ.md | 28 +++------------------ docs/en/statements/bug-report.md | 38 +++++++++++++++------------- docs/zh/advanced/FAQ.md | 26 +++---------------- docs/zh/statements/bug-report.md | 43 ++++++++++++++++---------------- 5 files changed, 50 insertions(+), 88 deletions(-) diff --git a/docs/.vuepress/theme.ts b/docs/.vuepress/theme.ts index 6fffb8dfc..a9267cf17 100644 --- a/docs/.vuepress/theme.ts +++ b/docs/.vuepress/theme.ts @@ -93,7 +93,8 @@ export default hopeTheme({ include: true, tabs: true, footnote: true, - align: true + align: true, + tasklist: true }, pwa: { diff --git a/docs/en/advanced/FAQ.md b/docs/en/advanced/FAQ.md index dd30c3539..434a4244c 100644 --- a/docs/en/advanced/FAQ.md +++ b/docs/en/advanced/FAQ.md @@ -23,32 +23,10 @@ Thanks to [solution provided by CzHUV](https://github.com/DGP-Studio/Snap.Hutao. ## How to create desktop shortcut with Administrator privilege -::: tip Community Power - -Thanks to [solution provided by Parsifa1](https://github.com/DGP-Studio/Snap.Hutao.Docs/issues/17)。 - -::: -Fundamental principle: Use the following PowerShell scrip can run Snap Hutao with Administrator privilege - -```PowerShell ts:no-line-numbers -Start-Process shell:AppsFolder\60568DGPStudio.SnapHutao_ebfp3nyc27j86!App -verb runas -``` - -- In your desktop, select `New` -> `Shortcut` -- In the field of `Type the location of the item`, input: - -```PowerShell ts:no-line-numbers -powershell -Command "Start-Process shell:AppsFolder\60568DGPStudio.SnapHutao_ebfp3nyc27j86!App -verb runas -``` +Starting from Snap Hutao 1.7.4, you can create a desktop shortcut with Administrator privilege by click `Create Desktop Shortcut` +in the settings page. -- Name the shortcut as `Snap Hutao` -- Confirm the creation, and you will get this shortcut with PowerShell logo -- Right-click on this shortcut, select `Properties` - - Change value of `Run` to `Minimized` - - Select `Change Icon`, fill the blank with `%ProgramFiles%\WindowsApps\60568DGPStudio.SnapHutao_1.6.6.0_x64__ebfp -3nyc27j86\Snap.Hutao.exe` and save the configuration -- Now, you get a shortcut of Snap Hutao with Administrator privilege - - You can also pin it to task bar or start menu +You can move this shortcut to any place you need. ## How to run Snap Hutao when Windows starts diff --git a/docs/en/statements/bug-report.md b/docs/en/statements/bug-report.md index d99c56425..fe09f4875 100644 --- a/docs/en/statements/bug-report.md +++ b/docs/en/statements/bug-report.md @@ -9,28 +9,32 @@ order: 2 # Submit Bug Report -![opened-issue](https://img.shields.io/github/issues/DGP-Studio/Snap.Hutao?style=for-the-badge) ![closed-issue](https://img.shields.io/github/issues-closed/DGP-Studio/Snap.Hutao?style=for-the-badge&color=blue) +You can submit bug reports when you find reproducible issue that cannot be fixed by yourself -## Recommended Method +Before submitting your issue, please do the following checklist: -- You can submit bug reports when you find reproducible issue that cannbot be fixed by youself -- When submitting the issue, you should describe the problem in as much detail as you can.Screenshots of error should be attached if you have.This is help us to identify the issue faster. - - A good example is [DGP-Studio/Snap.Hutao/issues/100](https://github.com/DGP-Studio/Snap.Hutao/issues/100) -- If you are able to fix the issue from code, you are also welcome to make PRs directly. +- [ ] Make sure you are in the latest version of Snap Hutao +- [ ] Check [FAQ](../advanced/FAQ.md) document and [known issues](../advanced/known-issue.md) document +- [ ] Search current issues in the project to see if there is same or similar issues -### Client Issue +If you don't get a solution from the above checklist, you can start a new issue on GitHub -- Check if the document already answered your issue +If you need some examples of good issues, you can check them [here](https://github.com/DGP-Studio/Snap.Hutao/issues?q=is%3Aissue+label%3A%E4%BC%98%E8%B4%A8%E9%97%AE%E9%A2%98+is%3Aclosed) - - Make sure you are in the latest version - - You can check FAQ document in the sidebar - - [FAQ](../advanced/FAQ.md) - -- Open an Issue +- Submit your issue on GitHub - [github.com/DGP-Studio/Snap.Hutao/issues/new/choose](https://github.com/DGP-Studio/Snap.Hutao/issues/new/choose) -- Open Issue on QQ Support (zh-CN only) - - [support.qq.com/products/451231](https://support.qq.com/products/451231) +- You should include these information in your issue: + - [ ] Your device ID + - [ ] Your operating system version + - [ ] Describe your issue in details, so the developer can replicate your problem + - [ ] How the issue being triggered? + - [ ] Is there any error or warning message from the program or your OS? + - [ ] Have you done any debug process by yourself? What's the outcome? + - [ ] If your issue is about program crash, you need to find `.NET error` on Snap Hutao in your Windows Event Viewer, + and include it in your issue + +## Request Document Update -### Request New or Update Document +If you think Snap Hutao document is missing some information or contains errors, you can start an issue on Snap.Hutao.Docs project -- Open issue on GitHub: [DGP-Studio/Snap.Hutao.Docs](https://github.com/DGP-Studio/Snap.Hutao.Docs/issues/new/choose) +- Submit your issue on GitHub：[DGP-Studio/Snap.Hutao.Docs](https://github.com/DGP-Studio/Snap.Hutao.Docs/issues/new/choose) diff --git a/docs/zh/advanced/FAQ.md b/docs/zh/advanced/FAQ.md index 5f52a59f6..3e26e6668 100644 --- a/docs/zh/advanced/FAQ.md +++ b/docs/zh/advanced/FAQ.md @@ -23,29 +23,9 @@ comment: false ## 如何添加一个默认以管理员方式运行的快捷方式 -::: tip 社区力量 -感谢 [Parsifa1 提供的解决方案](https://github.com/DGP-Studio/Snap.Hutao.Docs/issues/17) -::: -基本原理：使用下方的 PowerShell 脚本可以以管理员方式运行胡桃 - -```PowerShell ts:no-line-numbers -Start-Process shell:AppsFolder\60568DGPStudio.SnapHutao_ebfp3nyc27j86!App -verb runas -``` - -- 在桌面点击右键，选择`新建` -> `快捷方式` -- 在`请键入对象的位置`中直接输入: - -```PowerShell ts:no-line-numbers - powershell -Command "Start-Process shell:AppsFolder\60568DGPStudio.SnapHutao_ebfp3nyc27j86!App -verb runas -``` - -- 将快捷方式命名为你需要的名称，比如`Snap Hutao` -- 确认创建，此时你会在桌面得到一个有 PowerShell 图标的快捷方式 -- 右键该快捷方式，点击属性 - - 将`运行方式`修改为`最小化` - - 点击更改图标，选择`浏览`，并填写：`%ProgramFiles%\WindowsApps\60568DGPStudio.SnapHutao_1.6.6.0_x64__ebfp3nyc27j86\Snap.Hutao.exe`，回车确认保存 -- 这样你就获得了胡桃工具箱的桌面快捷方式，并且运行它将直接以管理员模式运行 - - 你也可以将固定到任务栏或磁贴区 +自 Snap Hutao 1.7.4 版本起，你可以在程序设置页面中点击`创建快捷方式`来在桌面上添加一个具有管理员权限的快捷方式 + +你可以移动这个快捷方式到你想要的地方 ## 如何让胡桃工具箱开机自动启动 diff --git a/docs/zh/statements/bug-report.md b/docs/zh/statements/bug-report.md index c8d6313f3..2dcda3f51 100644 --- a/docs/zh/statements/bug-report.md +++ b/docs/zh/statements/bug-report.md @@ -9,33 +9,32 @@ redirectFrom: /statements/bug-report.html # 提交 BUG 报告 -![opened-issue](https://img.shields.io/github/issues/DGP-Studio/Snap.Hutao?style=for-the-badge) -![closed-issue](https://img.shields.io/github/issues-closed/DGP-Studio/Snap.Hutao?style=for-the-badge&color=blue) +在你使用 Snap Hutao 时如果发现了可复现或不可自行修复的问题，可以通过提交问题反馈来告知开发者。 -## 推荐方法 +![suggestion](https://img.alicdn.com/imgextra/i3/1797064093/O1CN01jXBMbe1g6du15k9kx_!!1797064093.jpg_.webp) -- 在你使用 Snap Hutao 时如果发现了可复现或不可自行修复的问题，可以通过提交问题反馈来告知开发者。 -- 在提交问题时，您应当尽可能地详细描述问题。如果有错误的截图，也应该提供。这有利于问题排查并加速问题修复。 - - 一个可以参考的非常正面的例子是 [DGP-Studio/Snap.Hutao/issues/100](https://github.com/DGP-Studio/Snap.Hutao/issues/100) - - 你也可以通过[这个视频](https://www.bilibili.com/video/BV18T411z7R4)来学习如何发起并管理你在开源项目中的 issue -- 如果你有能力在代码层面修复该问题，也欢迎您直接在对应的项目中发起 PR。 - ![suggestion](https://img.alicdn.com/imgextra/i3/1797064093/O1CN01jXBMbe1g6du15k9kx_!!1797064093.jpg_.webp) - **如果你是诚心希望解决问题，则应该在 Issue 中包含尽可能多的信息，比如说：你做了什么；看到了什么结果；程序有什么提示； - 你查阅了哪篇文档；尝试了什么解决方案，结果是什么；你的设备 ID 是什么…… 当你愿意付出更多的时间在提供信息上，更大的可能获得一个准确的解决方案。 - 一两句话就结束的问题报告大多数不是有效的问题，只会被无视。** +在发起新的 Issue 之前，请先执行以下清单： -### 客户端问题 +- [ ] 当前使用的是最新版本客户端 +- [ ] 阅读[常见问题](../advanced/FAQ.md)文档和[已知问题](../advanced/known-issue.md)文档 +- [ ] 搜索项目 Issue，检查是否已有相同或类似的问题 +- 若执行上述步骤后没有得到问题解决方案，你可以在 GitHub 上发起一个新的 Issue -- **在提交问题前，请务必检查文档内是否已包含了你的问题** +如果你不清楚怎样是一个好的 Issue 可以阅读 Snap Hutao 过去的一些[优质问题](https://github.com/DGP-Studio/Snap.Hutao/issues?q=is%3Aissue+label%3A%E4%BC%98%E8%B4%A8%E9%97%AE%E9%A2%98+is%3Aclosed) - - 首先需要确认您使用的版本是否为最新版本 - - 您可以通过菜单栏中的“常见问题”分类找到这些文档 - - [常见问题](../advanced/FAQ.md) - - [当前版本已知问题](../advanced/known-issue.md) - -- 通过 GitHub 提交问题 +- 通过 GitHub 提交问题 - [github.com/DGP-Studio/Snap.Hutao/issues/new/choose](https://github.com/DGP-Studio/Snap.Hutao/issues/new/choose) - -### 请求增加或更新文档 +- 在 Issue 中，你应包含以下内容： + - [ ] 你的设备 ID + - [ ] 你的操作系统版本 + - [ ] 详细描述你的问题，开发人员应能根据你的描述复现问题 + - [ ] 问题是如何触发的 + - [ ] 程序或操作系统有怎样的错误提示 + - [ ] 你执行了怎样的操作排查问题，有什么结果 + - [ ] 如果你的问题涉及到程序崩溃，你需要在 Windows 事件查看器中寻找和 Snap Hutao 相关的 `.NET 错误` 并将其中的内容附加在 Issue 中 + +## 请求增加或更新文档 + +如果你认为 Snap Hutao 的文档缺少重要内容或有错误的信息，可以从 Snap.Hutao.Docs 项目中发起 Issue - 通过 GitHub 提交问题：[DGP-Studio/Snap.Hutao.Docs](https://github.com/DGP-Studio/Snap.Hutao.Docs/issues/new/choose)