From 43c0b345d2bfea12ebfa16c0f7312bff49c7ea57 Mon Sep 17 00:00:00 2001 From: Masterain Date: Sun, 17 Mar 2024 01:18:45 -0700 Subject: [PATCH] add descriptions --- docs/zh/advanced/FAQ.md | 11 ++++++----- docs/zh/advanced/Gacha-system-and-export-principal.md | 1 + docs/zh/advanced/exceptions.md | 1 + .../get-stoken-cookie-from-the-third-party.md | 1 + docs/zh/advanced/known-issue.md | 1 + docs/zh/advanced/uninstall.md | 4 +++- docs/zh/blog/version-1-9-0-breaking-changes.md | 1 + docs/zh/development/README.md | 1 + docs/zh/development/contribute.md | 3 ++- docs/zh/development/join.md | 3 ++- docs/zh/development/platform.md | 1 + docs/zh/statements/README.md | 1 + docs/zh/statements/bug-report.md | 1 + docs/zh/statements/privacy-notice.md | 1 + docs/zh/statements/tos.md | 1 + docs/zh/statements/update-log.md | 1 + 16 files changed, 25 insertions(+), 8 deletions(-) diff --git a/docs/zh/advanced/FAQ.md b/docs/zh/advanced/FAQ.md index 79816fc0c..5088dfa22 100644 --- a/docs/zh/advanced/FAQ.md +++ b/docs/zh/advanced/FAQ.md @@ -4,6 +4,7 @@ icon: iconfont icon-ask category: [FAQ] order: 1 comment: false +description: 本页包含了一些常见的与用户网络和程序生命周期问题相关的问题及解决方案。 --- # 其他常见问题 @@ -27,9 +28,9 @@ comment: false ### 如何让胡桃工具箱开机自动启动 - 请参考如下思路 - - 可以自行创建一个批处理文件，内容参考[此 issue](https://github.com/DGP-Studio/Snap.Hutao/issues/184)中，令胡桃以管理员模式直接运行的命令。 - - 设置一个**计划任务程序**令上述批处理文件开机自启，或将上述批处理文件加入**启动项**中 - - 使用 `SkipUAC` 等可以使软件以管理员身份静默自启的程序 + - 可以自行创建一个批处理文件，内容参考[此 issue](https://github.com/DGP-Studio/Snap.Hutao/issues/184)中，令胡桃以管理员模式直接运行的命令。 + - 设置一个**计划任务程序**令上述批处理文件开机自启，或将上述批处理文件加入**启动项**中 + - 使用 `SkipUAC` 等可以使软件以管理员身份静默自启的程序 - 或其他可以使胡桃工具箱开机自启的思路，敬请自行探索 ### 无法使用管理员模式启动胡桃工具箱 @@ -37,7 +38,7 @@ comment: false > 该问题仅存在于 Windows 10 低于 22H2 的版本中 - 当用户系统版本低于 `Windows Build 19045`（即 `Windows 10 22H2` 版本）时，可能无法通过管理员模式启动胡桃工具箱 - - 该问题属于 Windows 内核级别问题，难以判断具体来源，故建议用户升级至 Windows 10 最新版本 + - 该问题属于 Windows 内核级别问题，难以判断具体来源，故建议用户升级至 Windows 10 最新版本 ### 如何通过网络代理使用胡桃工具箱 @@ -48,4 +49,4 @@ comment: false 如果你需要通过网络代理使用 Snap Hutao，你有两种方法： 1. 在网络代理软件中启用 TUN 模式 -2. 在反馈中心中解除 Loopback 限制 \ No newline at end of file +2. 在反馈中心中解除 Loopback 限制 diff --git a/docs/zh/advanced/Gacha-system-and-export-principal.md b/docs/zh/advanced/Gacha-system-and-export-principal.md index bda85a620..e27847205 100644 --- a/docs/zh/advanced/Gacha-system-and-export-principal.md +++ b/docs/zh/advanced/Gacha-system-and-export-principal.md @@ -4,6 +4,7 @@ category: [FAQ] icon: iconfont icon-read order: 8 comment: false +description: Snap Hutao 使用多种方式获取用户的登录信息并配合原神 API 获取祈愿记录。 --- # 祈愿系统与导出原理 diff --git a/docs/zh/advanced/exceptions.md b/docs/zh/advanced/exceptions.md index 0cd087006..1c67dc215 100644 --- a/docs/zh/advanced/exceptions.md +++ b/docs/zh/advanced/exceptions.md @@ -4,6 +4,7 @@ icon: iconfont icon-warn category: [FAQ] order: 2 comment: false +description: 胡桃工具箱会使用特定的错误代码指示特定的错误，如果你在使用过程中遭遇了程序错误并且有一个错误代码，你可以尝试在该页查询。 --- # 常见的程序异常 diff --git a/docs/zh/advanced/get-stoken-cookie-from-the-third-party.md b/docs/zh/advanced/get-stoken-cookie-from-the-third-party.md index 65fae7802..dcb29574b 100644 --- a/docs/zh/advanced/get-stoken-cookie-from-the-third-party.md +++ b/docs/zh/advanced/get-stoken-cookie-from-the-third-party.md @@ -3,6 +3,7 @@ category: [FAQ, 第三方工具] icon: iconfont icon-read order: 7 comment: false +description: 一些第三方工具可以帮助你获取到包含 Stoken 字段值的米游社 cookie 并将其用于胡桃工具箱。 --- # 使用第三方工具获取有 Stoken 的 cookie diff --git a/docs/zh/advanced/known-issue.md b/docs/zh/advanced/known-issue.md index 7fb33a77a..825bce6e0 100644 --- a/docs/zh/advanced/known-issue.md +++ b/docs/zh/advanced/known-issue.md @@ -3,6 +3,7 @@ headerDepth: 2 icon: iconfont icon-tool category: [FAQ] order: 3 +description: 我们在 GitHub 议题页面使用了多种标签来标记用户提交的问题，你可以通过这些标签来确认问题的状态。 --- # 已知问题 diff --git a/docs/zh/advanced/uninstall.md b/docs/zh/advanced/uninstall.md index 86bb42a55..3c19abdb9 100644 --- a/docs/zh/advanced/uninstall.md +++ b/docs/zh/advanced/uninstall.md @@ -1,8 +1,10 @@ --- category: [FAQ] icon: iconfont icon-delete +tag: [卸载] order: 9 comment: false +description: 卸载胡桃工具箱是一个简单快速的过程，你可以根据本页教程，以最适合你的程度来卸载胡桃工具箱。 --- # 卸载胡桃工具箱 @@ -47,4 +49,4 @@ comment: false `Userdata.db` 包含你的全部客户端数据，包括安全敏感的米哈游论坛 Cookie，请妥善储存该文件，不要将其分享给任何人。 ::: -从在胡桃数据目录（默认路径为 `%userprofile%/Documents/Hutao`）中以复制的方式将 `Userdata.db` 拷贝至你的备份目录即可，该文件包含了全部的胡桃客户端数据。 \ No newline at end of file +从在胡桃数据目录（默认路径为 `%userprofile%/Documents/Hutao`）中以复制的方式将 `Userdata.db` 拷贝至你的备份目录即可，该文件包含了全部的胡桃客户端数据。 diff --git a/docs/zh/blog/version-1-9-0-breaking-changes.md b/docs/zh/blog/version-1-9-0-breaking-changes.md index 25c66b38e..8da74d207 100644 --- a/docs/zh/blog/version-1-9-0-breaking-changes.md +++ b/docs/zh/blog/version-1-9-0-breaking-changes.md @@ -2,6 +2,7 @@ category: [开发日志] order: 1 comment: false +description: 本文内容适用于Snap Hutao **1.4.11~1.8.4 版本**升级至 1.9.0 及更高版本 --- # 1.9.0 版本重大改变详解 diff --git a/docs/zh/development/README.md b/docs/zh/development/README.md index 14549ca1b..24f090ca7 100644 --- a/docs/zh/development/README.md +++ b/docs/zh/development/README.md @@ -6,6 +6,7 @@ icon: iconfont icon-git dir: text: 开源开发 order: 3 +description: 本页包含与 Snap Hutao 项目开发相关的公开文档目录。 --- # 开源开发 diff --git a/docs/zh/development/contribute.md b/docs/zh/development/contribute.md index bfca90398..7c52d9574 100644 --- a/docs/zh/development/contribute.md +++ b/docs/zh/development/contribute.md @@ -3,11 +3,12 @@ category: [开源, 开发] tag: ["开发", "GitHub"] icon: iconfont icon-code order: 3 +description: 胡桃工具箱使用 C# 和 .NET 框架开发桌面客户端和服务端。我们广泛地接受来自开源社区的反馈，如果你愿意贡献你的代码，请阅读本页的指导文档。 --- # 贡献你的代码 -胡桃工具箱使用 C# 和 .NET 框架开发桌面客户端和服务端。如果你愿意贡献你的代码，请阅读以下指导文档。 +胡桃工具箱使用 C# 和 .NET 框架开发桌面客户端和服务端。我们广泛地接受来自开源社区的反馈，如果你愿意贡献你的代码，请阅读本页的指导文档。 你可以在 GitHub 上查看所有当前仍然[未解决的问题](https://github.com/DGP-Studio/Snap.Hutao/issues?q=is%3Aissue+is%3Aopen+-label%3A%E5%B7%B2%E5%AE%8C%E6%88%90) diff --git a/docs/zh/development/join.md b/docs/zh/development/join.md index 0ed5c11e8..d62edcbef 100644 --- a/docs/zh/development/join.md +++ b/docs/zh/development/join.md @@ -8,11 +8,12 @@ tag: - 社区 icon: iconfont icon-group order: 1 +description: 如果你有本页所述技术之一且有兴趣加入 Snap Hutao 开发团队以完善项目，并接触到更多的原神开源项目，欢迎加入我们！ --- # 加入我们 -如果你有以下经验之一且有兴趣加入 Snap Hutao 开发团队以完善项目，并接触到更多的原神开源项目，欢迎加入我们！ +如果你有本页所述技术之一且有兴趣加入 Snap Hutao 开发团队以完善项目，并接触到更多的原神开源项目，欢迎加入我们！ **我们不会为下面需求设置明确的门槛。乐于探索新领域的精神、对技术的热情以及负责任的态度对于开源社区才是更重要的。** diff --git a/docs/zh/development/platform.md b/docs/zh/development/platform.md index 6c8f3694d..5bee8214b 100644 --- a/docs/zh/development/platform.md +++ b/docs/zh/development/platform.md @@ -3,6 +3,7 @@ category: [开源, 开发] tag: [开源, 胡桃数据库, 深渊数据库, Enka, UIGF, 数据开放] icon: iconfont icon-vscode order: 2 +description: 胡桃工具箱中包含了来自社区的创意，作为我们的回馈，我们也将一些服务公开于社区。如果它们对你的开发有帮助，请放心使用，我们会尽力维护这些分支项目。 --- # 胡桃开放平台 diff --git a/docs/zh/statements/README.md b/docs/zh/statements/README.md index f17c9c0fe..c3ddd97ec 100644 --- a/docs/zh/statements/README.md +++ b/docs/zh/statements/README.md @@ -6,6 +6,7 @@ icon: iconfont icon-blog dir: text: 声明和公告 order: 4 +description: 本页包含 Snap Hutao 全部声明和公告的目录。 --- # 声明和公告 diff --git a/docs/zh/statements/bug-report.md b/docs/zh/statements/bug-report.md index 413d30d46..14f8e6358 100644 --- a/docs/zh/statements/bug-report.md +++ b/docs/zh/statements/bug-report.md @@ -4,6 +4,7 @@ category: [公告] icon: iconfont icon-debug order: 2 comment: false +description: 胡桃工具箱是一个发布于 GitHub 的开源程序，我们亦使用 GitHub 议题功能来收集问题反馈，你可以通过 GitHub Issues 来提交问题报告。 --- # 提交 BUG 报告 diff --git a/docs/zh/statements/privacy-notice.md b/docs/zh/statements/privacy-notice.md index 00150a62e..9c3d61ae3 100644 --- a/docs/zh/statements/privacy-notice.md +++ b/docs/zh/statements/privacy-notice.md @@ -4,6 +4,7 @@ category: [公告] icon: iconfont icon-license order: 3 comment: false +description: 请详细阅读本页以获取 Snap Hutao 项目的用户数据处理和隐私权益。 --- # 用户数据和隐私权益 diff --git a/docs/zh/statements/tos.md b/docs/zh/statements/tos.md index e88941daf..36188d6fc 100644 --- a/docs/zh/statements/tos.md +++ b/docs/zh/statements/tos.md @@ -5,6 +5,7 @@ comment: false editLink: false icon: iconfont icon-license order: 4 +description: Snap Hutao 的用户使用协议和法律声明。 --- # 用户使用协议和法律声明 diff --git a/docs/zh/statements/update-log.md b/docs/zh/statements/update-log.md index c8a736eec..9485a7ad0 100644 --- a/docs/zh/statements/update-log.md +++ b/docs/zh/statements/update-log.md @@ -4,6 +4,7 @@ icon: iconfont icon-update order: 1 comment: false externalLinkIcon: false +description: Snap Hutao 通过持续地更新修复已知问题并发布全新功能，以保证用户获得最好的使用体验，我们将始终发布更新日志以追踪程序的变化。 --- # 更新日志