From 4141b65d5fd786026e7ebb8b486d7701632f9f36 Mon Sep 17 00:00:00 2001 From: Masterain Date: Thu, 3 Nov 2022 22:39:29 -0700 Subject: [PATCH] docs enhancement --- docs/quick-start.md | 12 +++++++----- docs/statements/bug-report.md | 23 ++++++++++++++--------- 2 files changed, 21 insertions(+), 14 deletions(-) diff --git a/docs/quick-start.md b/docs/quick-start.md index 899b13c6a..4245ec8e0 100644 --- a/docs/quick-start.md +++ b/docs/quick-start.md @@ -15,24 +15,26 @@ externalLinkIcon: false 胡桃工具箱目前处于测试阶段，不断地将 Snap Genshin 的功能迁移至胡桃工具箱中。你可以在 GitHub 项目发布页面和我们的网盘中下载到最新的测试版程序 - [从 GitHub 下载 ](https://github.com/DGP-Studio/Snap.Hutao/releases/) -- [从网盘下载 ](https://go.hut.ao/down) +- [从网盘下载](https://go.hut.ao/down) - 您下载的包含安装程序的压缩文件名如`Snap.Hutao_*_x64.zip`字样 ## 安装胡桃工具箱 ### 快速安装方式 -- [解压](https://jingyan.baidu.com/article/09ea3ede57eb3ac0aede390d.html)您从前述的[下载源](https://go.hut.ao/down)下载的压缩包 +- 解压已下载的压缩包 - 右键点击解压后的文件夹中的`Snap.Hutao.Installer.exe`文件，点击`使用管理员模式运行` - 安装完毕，`胡桃`将出现在您的`开始菜单`中 - 此时即可随意删除之前下载和解压的安装文件。 - 若您使用此种安装方式无法成功安装`胡桃`，请您尝试下述的`通用安装方式` - - 若上述步骤完成后，并未安装成功，建议检查[`杀毒软件`](https://baike.baidu.com/item/%E6%9D%80%E6%AF%92%E8%BD%AF%E4%BB%B6/622418)的启用情况(包含Windows Defender) + - 若上述步骤完成后，并未安装成功，建议检查杀毒软件的启用情况(包含Windows Defender) - 目前有案例表明，部分杀毒软件会在上述过程中，静默阻止修改策略或安装应用 ### 通用安装方式 - 在系统设置中打开`开发者设置`界面，勾选 `开发人员模式` 和 `允许 PowerShell 脚本` - - 若您无法理解前述内容，请见 [win10打开开发者模式的方法](https://jingyan.baidu.com/article/49711c6175e009bb441b7cf3.html)、[win11打开开发者模式的方法](https://jingyan.baidu.com/article/0bc808fc2923805ad485b9a4.html) -- [解压](https://jingyan.baidu.com/article/09ea3ede57eb3ac0aede390d.html)您从前述的[下载源](https://go.hut.ao/down)下载的压缩包 + - 可参考 + - [Windows 10打开开发者模式的方法](https://jingyan.baidu.com/article/49711c6175e009bb441b7cf3.html) + - [win11打开开发者模式的方法](https://jingyan.baidu.com/article/0bc808fc2923805ad485b9a4.html) +- 解压已下载的压缩包 - 找到`Install.ps1`文件 - 右键选择`使用PowerShell运行` - 按照提示允许PowerShell执行操作即可 diff --git a/docs/statements/bug-report.md b/docs/statements/bug-report.md index 68c8d36b5..0807a14a4 100644 --- a/docs/statements/bug-report.md +++ b/docs/statements/bug-report.md @@ -6,18 +6,23 @@ headerDepth: 0 ## 推荐方法 -> 在你使用 Snap Hutao 时如果发现了可复现或不可自行修复的问题 -> 可以在 GitHub 上提交 Issues 来让我们知道。 -> 在提交问题时，你应当尽可能地详细描述问题。 -> 你的 Issue 中应包含程序抛出的**完整**异常信息，当没有异常信息时也可以添加能显示出异常状态的截图。 -> 如果你有能力在代码层面修复该问题，也欢迎你直接在对应的项目中发起 PR。 +- 在你使用 Snap Hutao 时如果发现了可复现或不可自行修复的问题，可以通过提交问题反馈来告知开发者。 +- 在提交问题时，你应当尽可能地详细描述问题。如果有错误的截图，也应该提供。这有利于问题排查并加速问题修复。 + - 一个可以参考的非常正面的例子是 [DGP-Studio/Snap.Hutao/issues/100](https://github.com/DGP-Studio/Snap.Hutao/issues/100) +- 如果你有能力在代码层面修复该问题，也欢迎你直接在对应的项目中发起 PR。 -- 客户端本体问题 - [DGP-Studio/Snap.Hutao](https://github.com/DGP-Studio/Snap.Hutao/issues/new/choose) +### 客户端问题 + - 在提交问题前，请务必检查文档内是否已包含了你的问题 + - 你可以通过菜单栏中的“常见问题”分类找到这些文档 + - [快速解答](/FAQ/most-frequent-questions.md) + - 通过 GitHub 提交问题 + - [github.com/DGP-Studio/Snap.Hutao/issues/new/choose](https://github.com/DGP-Studio/Snap.Hutao/issues/new/choose) + - 通过 兔小巢 提交问题 + - [support.qq.com/products/451231](https://support.qq.com/products/451231) -- 请求增加或更新文档 - [DGP-Studio/Snap.Hutao.Docs](https://github.com/DGP-Studio/Snap.Hutao.Docs/issues/new) +### 请求增加或更新文档 + - 通过 GitHub 提交问题：[DGP-Studio/Snap.Hutao.Docs](https://github.com/DGP-Studio/Snap.Hutao.Docs/issues/new) ## 其它途径