Skip to content

docs: document GeneralUpdate.Tools workflows and artifacts#61

Closed
JusterZhu wants to merge 1 commit into
mainfrom
docs/issue-52-tools-draft
Closed

docs: document GeneralUpdate.Tools workflows and artifacts#61
JusterZhu wants to merge 1 commit into
mainfrom
docs/issue-52-tools-draft

Conversation

@JusterZhu

Copy link
Copy Markdown
Collaborator

Closes #52

Summary

  • Rewrite GeneralUpdate.Tools documentation from the latest Tools/Core source.
  • Cover Patch, Extension, OSS config, Config manifest, Simulation, Report, and Hash workflows.
  • Map generated artifacts to GeneralUpdate consumers and add troubleshooting notes.

Validation

  • git diff --check
  • npm run build -- --no-minify

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@JusterZhu

Copy link
Copy Markdown
Collaborator Author

Review findings (PR #70)

Three issues found:

  1. Bowl description is wrong: "可靠下载与断点续传" should be "进程崩溃监控与恢复" — Bowl monitors crashes, not downloads. The Bowl link should be removed from Tools docs since they're unrelated.

  2. Bowl has no relationship with Tools: GeneralUpdate.Tools generates patches/extensions/configs. Bowl monitors process health. Completely separate concerns.

  3. Content is too vague: Missing where-to-download, exact inputs/outputs per module, internal tool pipeline steps, downstream connection guidance, and a workflow diagram.

See PR #70 for a complete rewrite fixing all three issues.

@JusterZhu

Copy link
Copy Markdown
Collaborator Author

Closing: superseded by PR #70 which provides a more complete rewrite of the GeneralUpdate.Tools documentation.

@JusterZhu JusterZhu closed this Jun 3, 2026
JusterZhu added a commit that referenced this pull request Jun 3, 2026
…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 added a commit that referenced this pull request Jun 3, 2026
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 JusterZhu deleted the docs/issue-52-tools-draft branch June 3, 2026 16:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs subtask: document GeneralUpdate.Tools workflows and artifacts

1 participant