docs: rewrite GeneralUpdate.Tools doc — accurate, specific, no Bowl#70
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR rewrites the GeneralUpdate.Tools documentation pages (previously “PacketTool”) to be more accurate and actionable, including removing incorrect/irrelevant “Bowl” content and documenting the end-to-end artifact workflow across Tools modules.
Changes:
- Replaced the old high-level/partially inaccurate descriptions with a structured, module-by-module workflow guide (inputs → internal steps → outputs → downstream consumers).
- Removed Bowl-related description and related-doc links from the Tools documentation.
- Added concrete examples (file layouts, JSON examples) plus a recommended release workflow and FAQ troubleshooting section.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 6 comments.
| File | Description |
|---|---|
| website/docs/doc/GeneralUpdate.PacketTool.md | Rewrites the primary (default) Tools doc with module-specific workflows, artifacts, and troubleshooting. |
| website/i18n/en/docusaurus-plugin-content-docs/current/doc/GeneralUpdate.PacketTool.md | English version of the same rewritten Tools doc. |
| website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/doc/GeneralUpdate.PacketTool.md | zh-Hans i18n version of the rewritten Tools doc. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+356
to
+357
| - [入门实战手册](../quickstart/Beginner cookbook.md)：从零跑通完整更新闭环 | ||
| - [高级实战手册](../quickstart/Advanced cookbook.md)：CI/CD 集成与生产发布 |
Comment on lines
+345
to
+346
| - [Beginner cookbook](../quickstart/Beginner cookbook.md): Complete end-to-end update walkthrough | ||
| - [Advanced cookbook](../quickstart/Advanced cookbook.md): CI/CD integration and production releases |
Comment on lines
+356
to
+357
| - [入门实战手册](../quickstart/Beginner cookbook.md)：从零跑通完整更新闭环 | ||
| - [高级实战手册](../quickstart/Advanced cookbook.md)：CI/CD 集成与生产发布 |
Comment on lines
+356
to
+357
| - [入门实战手册](../quickstart/Beginner cookbook.md)：从零跑通完整更新闭环 | ||
| - [高级实战手册](../quickstart/Advanced cookbook.md)：CI/CD 集成与生产发布 |
Comment on lines
+345
to
+346
| - [Beginner cookbook](../quickstart/Beginner cookbook.md): Complete end-to-end update walkthrough | ||
| - [Advanced cookbook](../quickstart/Advanced cookbook.md): CI/CD integration and production releases |
Comment on lines
+356
to
+357
| - [入门实战手册](../quickstart/Beginner cookbook.md)：从零跑通完整更新闭环 | ||
| - [高级实战手册](../quickstart/Advanced cookbook.md)：CI/CD 集成与生产发布 |
…cificity Fixes three issues with the current PR #61 draft: 1. Remove incorrect Bowl reference — Bowl monitors process crashes, it has nothing to do with download resume or Tools workflows 2. Remove irrelevant Bowl link from Tools docs — GeneralUpdate.Tools and Bowl have no relationship 3. Make documentation specific and actionable: - Add explicit download/install instructions (source + pre-built) - Document exact inputs and outputs per module with field tables - Explain what each module solves, what it does internally, and how downstream consumers use its outputs - Add recommended release workflow diagram connecting all 6 modules - Add FAQ covering common error scenarios - All code examples and API references verified against actual GeneralUpdate.Tools source code Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
JusterZhu
force-pushed
the
docs/fix-tools-doc
branch
from
0e6bdf6 to
099e93d
Compare
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.
Fixes issues in #61.
Issues fixed
1. Incorrect Bowl description
The original PR described Bowl as "可靠下载与断点续传" (reliable download and resume). Bowl monitors process crashes and performs backup recovery — it has nothing to do with download resume. Removed entirely.
2. Irrelevant Bowl link
GeneralUpdate.Tools and Bowl have no relationship. The Bowl link has been removed from the related docs section.
3. Too vague — now specific and actionable
Every module now answers for the developer:
Structure
Validation
npm run build -- --no-minifypasses