From b06f142045f7937bb99c0430784a86591e7761a7 Mon Sep 17 00:00:00 2001 From: Masterain Date: Sun, 17 Mar 2024 01:39:10 -0700 Subject: [PATCH] add description --- docs/en/advanced/FAQ.md | 1 + docs/en/advanced/Gacha-system-and-export-principal.md | 1 + docs/en/advanced/exceptions.md | 1 + docs/en/advanced/get-stoken-cookie-from-the-third-party.md | 1 + docs/en/advanced/known-issue.md | 1 + docs/en/advanced/uninstall.md | 3 ++- docs/en/development/contribute.md | 1 + docs/en/development/join.md | 1 + docs/en/development/platform.md | 1 + docs/en/features/README.md | 1 + docs/en/features/achievements.md | 1 + docs/en/features/character-data.md | 1 + docs/en/features/character-wiki.md | 1 + docs/en/features/dashboard.md | 1 + docs/en/features/develop-plan.md | 1 + docs/en/features/feedback-center.md | 1 + docs/en/features/game-launcher.md | 1 + docs/en/features/hutao-API.md | 1 + docs/en/features/hutao-passport.md | 1 + docs/en/features/hutao-settings.md | 1 + docs/en/features/mhy-account-switch.md | 1 + docs/en/features/monster-wiki.md | 1 + docs/en/features/real-time-notes.md | 1 + docs/en/features/setup.md | 1 + docs/en/features/weapon-wiki.md | 1 + docs/en/features/wish-export.md | 1 + docs/en/statements/README.md | 1 + docs/en/statements/bug-report.md | 1 + docs/en/statements/privacy-notice.md | 1 + docs/en/statements/tos.md | 1 + docs/en/statements/update-log.md | 1 + docs/zh/features/game-launcher.md | 2 +- 32 files changed, 33 insertions(+), 2 deletions(-) diff --git a/docs/en/advanced/FAQ.md b/docs/en/advanced/FAQ.md index 5433ca137..52a9801bb 100644 --- a/docs/en/advanced/FAQ.md +++ b/docs/en/advanced/FAQ.md @@ -4,6 +4,7 @@ icon: iconfont icon-ask category: - FAQ order: 1 +description: This page contains some common issues and solutions related to user networking and program lifecycle problems. --- # Other FAQ diff --git a/docs/en/advanced/Gacha-system-and-export-principal.md b/docs/en/advanced/Gacha-system-and-export-principal.md index f38d40e54..7b18b7212 100644 --- a/docs/en/advanced/Gacha-system-and-export-principal.md +++ b/docs/en/advanced/Gacha-system-and-export-principal.md @@ -5,6 +5,7 @@ category: icon: iconfont icon-read order: 8 comment: false +description: Snap Hutao utilizes various methods to obtain users' login information and combines it with the Genshin Impact API to retrieve gacha records. --- # Gacha System and Export Principle diff --git a/docs/en/advanced/exceptions.md b/docs/en/advanced/exceptions.md index f7afdb25b..420d4649f 100644 --- a/docs/en/advanced/exceptions.md +++ b/docs/en/advanced/exceptions.md @@ -4,6 +4,7 @@ icon: iconfont icon-warn category: [FAQ] order: 2 comment: false +description: The Snap Hutao toolbox utilizes specific error codes to indicate particular errors. If you encounter a program error during usage and have an error code, you can try searching for it on this page. --- # Common Program Exceptions diff --git a/docs/en/advanced/get-stoken-cookie-from-the-third-party.md b/docs/en/advanced/get-stoken-cookie-from-the-third-party.md index 1e2b51cf9..e12bdf0a8 100644 --- a/docs/en/advanced/get-stoken-cookie-from-the-third-party.md +++ b/docs/en/advanced/get-stoken-cookie-from-the-third-party.md @@ -5,6 +5,7 @@ category: icon: iconfont icon-read order: 7 comment: false +description: There are some third-party tools that can help you obtain the cookie from the miHoYo community with the Stoken field value and use it for Snap Hutao. --- # Obtaining Stoken-containing Cookies Using Third-Party Tools diff --git a/docs/en/advanced/known-issue.md b/docs/en/advanced/known-issue.md index d094777bf..86f95229e 100644 --- a/docs/en/advanced/known-issue.md +++ b/docs/en/advanced/known-issue.md @@ -4,6 +4,7 @@ icon: iconfont icon-tool category: - FAQ order: 3 +description: We use a variety of labels on our GitHub issue page to categorize and track the status of user-submitted issues. You can rely on these labels to determine the status of a problem. --- # Known Issue diff --git a/docs/en/advanced/uninstall.md b/docs/en/advanced/uninstall.md index ac05d5f4b..0eadb4244 100644 --- a/docs/en/advanced/uninstall.md +++ b/docs/en/advanced/uninstall.md @@ -4,6 +4,7 @@ category: icon: iconfont icon-delete order: 9 comment: false +description: Uninstalling Snap Hutao is a simple and fast process. You can follow the instructions on this page to uninstall Snap Hutao according to your level of proficiency. --- # Uninstall Snap Hutao @@ -41,4 +42,4 @@ with anyone. ::: Copy `Userdata.db` from Snap Hutao data folder (`%userprofile%/Documents/Hutao` by default) to your backup location, this -file contains entire data of the client. \ No newline at end of file +file contains entire data of the client. diff --git a/docs/en/development/contribute.md b/docs/en/development/contribute.md index 6a83f2391..2cfee8c3b 100644 --- a/docs/en/development/contribute.md +++ b/docs/en/development/contribute.md @@ -3,6 +3,7 @@ category: [open source, development] tag: ["development", "GitHub"] icon: iconfont icon-code order: 3 +description: Snap Hutao is developed using C# and the .NET framework for both the desktop client and the server. We greatly appreciate feedback from the open-source community, and if you're willing to contribute your code, please refer to the instructions in the documentation on this page. --- # Contribute Your Code diff --git a/docs/en/development/join.md b/docs/en/development/join.md index 6339e8b17..51dc6c7d2 100644 --- a/docs/en/development/join.md +++ b/docs/en/development/join.md @@ -8,6 +8,7 @@ tag: - community icon: iconfont icon-group order: 1 +description: If you possess expertise in any of the technologies mentioned on this page and are interested in joining the Snap Hutao development team to enhance the project and engage with more open-source projects related to Genshin Impact, we welcome you to join us! --- # Join the Develop Team diff --git a/docs/en/development/platform.md b/docs/en/development/platform.md index 3a91f52b7..9a39d9f48 100644 --- a/docs/en/development/platform.md +++ b/docs/en/development/platform.md @@ -3,6 +3,7 @@ category: [open source, development] tag: [open source, Hutao Database, Spiral Abyss Database, Enka, UIGF, Open data] icon: iconfont icon-vscode order: 2 +description: Snap Hutao incorporates ideas from the community, and as our way of giving back, we also make certain services available to the community. If they are helpful to your development, feel free to use them, and we will do our best to maintain these forked projects. --- # Hutao Open Platform diff --git a/docs/en/features/README.md b/docs/en/features/README.md index 4530dca6e..d1c1378e0 100644 --- a/docs/en/features/README.md +++ b/docs/en/features/README.md @@ -6,6 +6,7 @@ icon: iconfont icon-module dir: text: Features order: 1 +description: In the Feature directory, you can find a comprehensive list of all the features currently available in Snap Hutao. You can refer to this directory to search for the corresponding documentation of each feature based on your specific needs. --- # Features diff --git a/docs/en/features/achievements.md b/docs/en/features/achievements.md index b40d433b6..c62d0e85e 100644 --- a/docs/en/features/achievements.md +++ b/docs/en/features/achievements.md @@ -4,6 +4,7 @@ category: [Feature, Tutorial] tag: [Achievement] order: 6 comment: false +description: Snap Hutao provides the functionality to manage Genshin Impact achievements. With it, you can browse and manage the status of all achievements. Using its powerful filtering system, you can easily search for specific achievements based on version number, achievement name, achievement description, and region affiliation. --- # Achievement Management diff --git a/docs/en/features/character-data.md b/docs/en/features/character-data.md index f662ea9ec..e9dbc1fa9 100644 --- a/docs/en/features/character-data.md +++ b/docs/en/features/character-data.md @@ -4,6 +4,7 @@ category: [Feature, Tutorial] tag: [Character showcase, Character statistics] order: 8 comment: false +description: The "My Characters" feature in Snap Hutao can retrieve and display specific data of the characters owned within a Genshin Impact account. It provides analytical data such as character level, constellations, talents, and artifact ratings. --- # My Characters diff --git a/docs/en/features/character-wiki.md b/docs/en/features/character-wiki.md index 461a6a6c2..829edbab6 100644 --- a/docs/en/features/character-wiki.md +++ b/docs/en/features/character-wiki.md @@ -4,6 +4,7 @@ category: [Feature, Tutorial] tag: [Character, WIKI, Data] order: 11 comment: false +description: The "Character Wiki" feature in Snap Hutao includes comprehensive information about all the characters in Genshin Impact. It provides essential data such as base information, talent values, constellations, and other important details. This feature helps players easily access and gather information about different characters in the game. --- # Character WIKI diff --git a/docs/en/features/dashboard.md b/docs/en/features/dashboard.md index 5cac18b30..a904c7bfd 100644 --- a/docs/en/features/dashboard.md +++ b/docs/en/features/dashboard.md @@ -4,6 +4,7 @@ category: [Feature, Tutorial] order: 2 tag: [Dashboard, Announcement] comment: false +description: In the dashboard of Snap Hutao, users can not only quickly view an overview of their current account data but also access real-time in-game announcements. --- # Home Dashboard diff --git a/docs/en/features/develop-plan.md b/docs/en/features/develop-plan.md index 821727565..99e0501e3 100644 --- a/docs/en/features/develop-plan.md +++ b/docs/en/features/develop-plan.md @@ -4,6 +4,7 @@ category: [Feature, Tutorial] tag: [develop plan, develop calculator] order: 10 comment: false +description: The "Development Plan" feature in Snap Hutao assists players in quickly creating cultivation checklists for characters and weapons, allowing them to easily track the obtainable targets they own and plan to cultivate. --- # Development Plan diff --git a/docs/en/features/feedback-center.md b/docs/en/features/feedback-center.md index 36010293b..a4bff34f1 100644 --- a/docs/en/features/feedback-center.md +++ b/docs/en/features/feedback-center.md @@ -4,6 +4,7 @@ category: [Feature, Tutorial] order: 3 tag: [feedback, issue] comment: false +description: The built-in Feedback Center in Snap Hutao includes important links related to the Snap Hutao project and incorporates a document search engine. This enables players to resolve common issues and find solutions within the program itself. --- # Feedback Center diff --git a/docs/en/features/game-launcher.md b/docs/en/features/game-launcher.md index 1f950331d..22d76ea0e 100644 --- a/docs/en/features/game-launcher.md +++ b/docs/en/features/game-launcher.md @@ -4,6 +4,7 @@ category: [Feature, Tutorial] tag: [unlock framerate, convert server, switch account] order: 4 comment: false +description: The game launcher within Snap Hutao offers additional features that enhance the gaming experience beyond what the official launcher provides. In addition to allowing users to add custom launch parameters, it also includes features such as server switching and unlocking frame rates. These features significantly improve the overall gaming experience. --- # Game Launcher diff --git a/docs/en/features/hutao-API.md b/docs/en/features/hutao-API.md index 4bd429efc..1162a79d3 100644 --- a/docs/en/features/hutao-API.md +++ b/docs/en/features/hutao-API.md @@ -4,6 +4,7 @@ category: [Feature, Tutorial] tag: [Spiral Abyss, Spiral Abyss Database, Spiral Abyss Analytics] order: 9 comment: false +description: The built-in Hutao Database feature in Snap Hutao is a database that helps players archive and query data for Abyssal Domains challenges. Players can easily obtain and locally archive data for each period of Abyssal Domains challenges with a single click, and submit the data to the Hutao Abyss Database. --- # Hutao Database / Abyss Record diff --git a/docs/en/features/hutao-passport.md b/docs/en/features/hutao-passport.md index 5090299a2..1b88874b4 100644 --- a/docs/en/features/hutao-passport.md +++ b/docs/en/features/hutao-passport.md @@ -4,6 +4,7 @@ category: [Feature, Tutorial] order: 16 tag: [Snap Hutao Account, Snap Hutao Cloud, Hutao Passport] comment: false +description: The Hutao Passport is the account system under the Snap Hutao project, which allows players to log in to the Hutao Cloud system and access benefits. --- # Snap Hutao Account diff --git a/docs/en/features/hutao-settings.md b/docs/en/features/hutao-settings.md index 1b7360675..602eaf305 100644 --- a/docs/en/features/hutao-settings.md +++ b/docs/en/features/hutao-settings.md @@ -5,6 +5,7 @@ tag: [Snap Hutao Cloud, Geetest verification, Language settings, Advanced settings] order: 15 comment: false +description: The Settings page of Snap Hutao contains various options to customize different aspects of the program. By modifying the settings on this page, users can personalize Snap Hutao to achieve the desired user experience. --- # Software Settings diff --git a/docs/en/features/mhy-account-switch.md b/docs/en/features/mhy-account-switch.md index 67810c529..0ebe0a52f 100644 --- a/docs/en/features/mhy-account-switch.md +++ b/docs/en/features/mhy-account-switch.md @@ -4,6 +4,7 @@ category: [Feature, Tutorial] tag: [MiYouShe, HoYoLAB, Multi account, check-in] order: 14 comment: false +description: The Multi-Account Panel feature in Snap Hutao allows users to log in with multiple miHoYo BBS accounts within the toolbox and switch between them freely. This enables users to utilize various functions within the toolbox with different accounts for specific purposes. --- # MiHoYo BBS Account Switch diff --git a/docs/en/features/monster-wiki.md b/docs/en/features/monster-wiki.md index df1e2087f..0a496d22a 100644 --- a/docs/en/features/monster-wiki.md +++ b/docs/en/features/monster-wiki.md @@ -4,6 +4,7 @@ category: [Feature, Tutorial] tag: [monster, WIKI, data] order: 13 comment: false +description: The Monster Wiki is an integrated monster database within Snap Hutao. Players can use this feature to access detailed information on all monsters in Genshin Impact. By analyzing the monsters, players can strategize and reduce the difficulty of the game. --- # Monster WIKI diff --git a/docs/en/features/real-time-notes.md b/docs/en/features/real-time-notes.md index 90364fbb0..20d5ca630 100644 --- a/docs/en/features/real-time-notes.md +++ b/docs/en/features/real-time-notes.md @@ -4,6 +4,7 @@ category: [Feature, Tutorial] tag: [Real-time Notes, Expeditions, Resin] order: 7 comment: false +description: The Real-time Note feature in Snap Hutao synchronizes dynamic information from Genshin Impact to your local computer by periodically refreshing your miHoYo account data. It allows you to set conditions for message reminders and push notifications based on your preferences. This feature helps you stay updated with the latest in-game events, announcements, and other relevant information in real-time. --- # Real-time Notes diff --git a/docs/en/features/setup.md b/docs/en/features/setup.md index c59bf1d95..03c6025dc 100644 --- a/docs/en/features/setup.md +++ b/docs/en/features/setup.md @@ -3,6 +3,7 @@ headerDepth: 2 category: [Feature, Tutorial] order: 1 comment: false +description: The new user onboarding feature in Snap Hutao helps users quickly check the availability status of specific program functionalities and set them to an available state. --- # Initial Setup Guide diff --git a/docs/en/features/weapon-wiki.md b/docs/en/features/weapon-wiki.md index 3c573cd46..17d3cd433 100644 --- a/docs/en/features/weapon-wiki.md +++ b/docs/en/features/weapon-wiki.md @@ -4,6 +4,7 @@ category: [Feature, Tutorial] tag: [Weapon, WIKI, Data] order: 12 comment: false +description: The Weapons Wiki is an integrated weapon database within the Snap Hutao toolbox. Players can use this feature to access detailed information about all weapons in Genshin Impact and choose suitable weapons for their characters. --- # Weapon WIKI diff --git a/docs/en/features/wish-export.md b/docs/en/features/wish-export.md index afa8e3a69..d928efa64 100644 --- a/docs/en/features/wish-export.md +++ b/docs/en/features/wish-export.md @@ -4,6 +4,7 @@ category: [Feature, Tutorial] tag: [wish export, gacha, wish] order: 5 comment: false +description: The Wish Export feature allows players to freely export their current wish data from their game accounts and permanently store and backup it locally. This enables long-term data accumulation for tracking and analyzing wish data. --- # Wish History diff --git a/docs/en/statements/README.md b/docs/en/statements/README.md index 6c331718b..94a3f16cc 100644 --- a/docs/en/statements/README.md +++ b/docs/en/statements/README.md @@ -6,6 +6,7 @@ icon: iconfont icon-blog dir: text: Statements order: 4 +description: This page contains the toc of statements and announcements of Snap Hutao project. --- # Statements diff --git a/docs/en/statements/bug-report.md b/docs/en/statements/bug-report.md index 981100447..1eaabc452 100644 --- a/docs/en/statements/bug-report.md +++ b/docs/en/statements/bug-report.md @@ -5,6 +5,7 @@ category: icon: iconfont icon-debug comment: false order: 2 +description: Snap Hutao is an open-source program released on GitHub. We also utilize the GitHub Issues feature to collect feedback and address any issues. You can submit problem reports through GitHub Issues. --- # Submit Bug Report diff --git a/docs/en/statements/privacy-notice.md b/docs/en/statements/privacy-notice.md index a4d1e4a02..49b514bb5 100644 --- a/docs/en/statements/privacy-notice.md +++ b/docs/en/statements/privacy-notice.md @@ -4,6 +4,7 @@ category: - Announcement icon: iconfont icon-license order: 3 +description: Please read this page carefully to understand the user data handling and privacy rights for the Snap Hutao project. --- # User Data and Privacy Notice diff --git a/docs/en/statements/tos.md b/docs/en/statements/tos.md index 91e1e4659..1203ba6ff 100644 --- a/docs/en/statements/tos.md +++ b/docs/en/statements/tos.md @@ -6,6 +6,7 @@ comment: false editLink: false icon: iconfont icon-license order: 4 +description: User agreement and legal notices of Snap Hutao project. --- # User Agreement and Legal Notices diff --git a/docs/en/statements/update-log.md b/docs/en/statements/update-log.md index 7c1e394cf..ef70c414d 100644 --- a/docs/en/statements/update-log.md +++ b/docs/en/statements/update-log.md @@ -5,6 +5,7 @@ icon: iconfont icon-update order: 1 comment: false externalLinkIcon: false +description: Snap Hutao strives to provide users with the best user experience by continuously updating and fixing known issues and releasing new features. We will always publish update logs to track the changes made to the program. --- # Update Logs diff --git a/docs/zh/features/game-launcher.md b/docs/zh/features/game-launcher.md index 330cb8b55..00cf1e33e 100644 --- a/docs/zh/features/game-launcher.md +++ b/docs/zh/features/game-launcher.md @@ -4,7 +4,7 @@ category: [功能, 教程] tag: [帧率解锁, 服务器转换, 切换帐号] order: 4 comment: false -description: 胡桃工具箱内的游戏启动器相交于官方启动器，不仅允许用户添加自定义的启动参数，还内置了服务器转换和解锁帧率等显著提升游戏体验的功能。 +description: 胡桃工具箱内的游戏启动器相较于官方启动器，不仅允许用户添加自定义的启动参数，还内置了服务器转换和解锁帧率等显著提升游戏体验的功能。 --- # 高级启动器