docs: add beginner GeneralUpdate cookbook#62
Merged
Conversation
JusterZhu
force-pushed
the
docs/issue-53-beginner-cookbook-draft
branch
from
bee16fe to
e7b3bd7
Compare
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
JusterZhu
force-pushed
the
docs/issue-53-beginner-cookbook-draft
branch
from
e7b3bd7 to
ae51e28
Compare
There was a problem hiding this comment.
Pull request overview
Adds a new “Beginner cookbook” quickstart document intended to walk first-time GeneralUpdate users through an end-to-end update loop (Client → Server → Tools-generated package → Upgrade), with localized copies for English and zh-Hans.
Changes:
- Added a step-by-step beginner cookbook covering the full discovery/download/upgrade/apply flow and expected results per step.
- Documented the roles of Hub, Server, Packet, Tools, Bowl, and Differential within the Samples update loop.
- Added localized copies under
website/i18n/enandwebsite/i18n/zh-Hans.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 6 comments.
| File | Description |
|---|---|
| website/docs/quickstart/Beginner cookbook.md | Adds the default-locale beginner cookbook (step-by-step update loop walkthrough). |
| website/i18n/en/docusaurus-plugin-content-docs/current/quickstart/Beginner cookbook.md | Adds English localized version of the beginner cookbook. |
| website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/quickstart/Beginner cookbook.md | Adds zh-Hans localized version of the beginner cookbook. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| | Old Directory | 用户当前安装的旧版本目录，例如 `publish\v1.0.0` | | ||
| | New Directory | 你准备发布的新版本目录，例如 `publish\v2.0.0` | | ||
| | Package Name | 建议包含版本，例如 `client_1.0.0_to_2.0.0` | | ||
| | Version | 目标版本，例如 `2.0.0` | |
| 2. [GeneralUpdate.Tools](../doc/GeneralUpdate.PacketTool.md)：补丁包、Hash、OSS Config、Simulation。 | ||
| 3. [GeneralUpdate.Differential](../doc/GeneralUpdate.Differential.md)：差分算法、并行处理和 Clean/Dirty。 | ||
| 4. [GeneralUpdate.Bowl](../doc/GeneralUpdate.Bowl.md)：崩溃监控、备份和失败恢复。 | ||
| 5. [高级实战手册](./Advanced cookbook.md)：生产环境部署、CI/CD 集成、企业级方案设计。 |
| | Old Directory | 用户当前安装的旧版本目录，例如 `publish\v1.0.0` | | ||
| | New Directory | 你准备发布的新版本目录，例如 `publish\v2.0.0` | | ||
| | Package Name | 建议包含版本，例如 `client_1.0.0_to_2.0.0` | | ||
| | Version | 目标版本，例如 `2.0.0` | |
| 2. [GeneralUpdate.Tools](../doc/GeneralUpdate.PacketTool.md)：补丁包、Hash、OSS Config、Simulation。 | ||
| 3. [GeneralUpdate.Differential](../doc/GeneralUpdate.Differential.md)：差分算法、并行处理和 Clean/Dirty。 | ||
| 4. [GeneralUpdate.Bowl](../doc/GeneralUpdate.Bowl.md)：崩溃监控、备份和失败恢复。 | ||
| 5. [高级实战手册](./Advanced cookbook.md)：生产环境部署、CI/CD 集成、企业级方案设计。 |
| | Old Directory | The version users currently have, such as `publish\v1.0.0` | | ||
| | New Directory | The version you want to release, such as `publish\v2.0.0` | | ||
| | Package Name | Include versions, such as `client_1.0.0_to_2.0.0` | | ||
| | Version | Target version, such as `2.0.0` | |
| 2. [GeneralUpdate.Tools](../doc/GeneralUpdate.PacketTool.md): patch packages, Hash, OSS Config, and Simulation. | ||
| 3. [GeneralUpdate.Differential](../doc/GeneralUpdate.Differential.md): differential algorithms, parallel processing, and Clean/Dirty. | ||
| 4. [GeneralUpdate.Bowl](../doc/GeneralUpdate.Bowl.md): crash monitoring, backup, and failure recovery. | ||
| 5. [Advanced Cookbook](./Advanced cookbook.md): production deployment, CI/CD integration, enterprise solution design. |
This was referenced Jun 3, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #53
Summary
Validation