Draft: GeneralUpdate.Bowl component documentation#58
Merged
Conversation
Refs #48 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
JusterZhu
force-pushed
the
docs/issue-48-bowl-draft
branch
from
c651e1a to
ce1c144
Compare
There was a problem hiding this comment.
Pull request overview
This PR rewrites the GeneralUpdate.Bowl documentation (Chinese + English) to match the current post-upgrade “startup guard” behavior and the BowlContext + LaunchAsync API, including crash capture outputs, rollback behavior, callbacks, tracing, and platform differences.
Changes:
- Replaced legacy “component overview / core features” docs with an updated lifecycle-first explanation and practical setup flow.
- Added detailed sections for crash detection + recovery pipeline, output artifacts,
OnCrashcallback, and trace logging control. - Synced the same content structure across
website/docs(zh) and i18n (en / zh-Hans).
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 6 comments.
| File | Description |
|---|---|
| website/docs/doc/GeneralUpdate.Bowl.md | Rewritten zh docs for Bowl around BowlContext / LaunchAsync, adding lifecycle + recovery + outputs + callbacks + platform notes. |
| website/i18n/en/docusaurus-plugin-content-docs/current/doc/GeneralUpdate.Bowl.md | English version of the rewritten Bowl docs with the same structure and updated examples. |
| website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/doc/GeneralUpdate.Bowl.md | zh-Hans version of the rewritten Bowl docs aligned with the updated API and behavior. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+280
to
+284
| 旧示例中的 `GeneralUpdate.Bowl.Strategys.MonitorParameter` 已标记为过时，推荐迁移到 `BowlContext` 和异步入口： | ||
|
|
||
| | 产品 | 版本 | | ||
| | --------------- | ----------------- | | ||
| | .NET | 5, 6, 7, 8, 9, 10 | | ||
| | .NET Framework | 4.6.1 | | ||
| | .NET Standard | 2.0 | | ||
| | .NET Core | 2.0 | | ||
| | ASP.NET | Any | | ||
| ```csharp | ||
| var oldParameter = new GeneralUpdate.Bowl.Strategys.MonitorParameter | ||
| { |
| - **示例代码**：[查看 GitHub 示例](https://github.com/GeneralLibrary/GeneralUpdate-Samples/tree/main/src/Bowl) | ||
| - **视频教程**：[观看 Bilibili 教程](https://www.bilibili.com/video/BV1c8iyYZE7P) | ||
| - **主仓库**：[GeneralUpdate 项目](https://github.com/GeneralLibrary/GeneralUpdate) | ||
| - **示例代码**：[GeneralUpdate-Samples / Bowl](https://github.com/GeneralLibrary/GeneralUpdate-Samples/tree/main/src/Bowl) |
Comment on lines
+280
to
+284
| The old `GeneralUpdate.Bowl.Strategys.MonitorParameter` type is obsolete. Prefer `BowlContext` and the async entry point: | ||
|
|
||
| | Product | Version | | ||
| | --------------- | ----------------- | | ||
| | .NET | 5, 6, 7, 8, 9, 10 | | ||
| | .NET Framework | 4.6.1 | | ||
| | .NET Standard | 2.0 | | ||
| | .NET Core | 2.0 | | ||
| | ASP.NET | Any | | ||
| ```csharp | ||
| var oldParameter = new GeneralUpdate.Bowl.Strategys.MonitorParameter | ||
| { |
| - **Example Code**: [View GitHub Examples](https://github.com/GeneralLibrary/GeneralUpdate-Samples/tree/main/src/Bowl) | ||
| - **Video Tutorial**: [Watch Bilibili Tutorial](https://www.bilibili.com/video/BV1c8iyYZE7P) | ||
| - **Main Repository**: [GeneralUpdate Project](https://github.com/GeneralLibrary/GeneralUpdate) | ||
| - **Samples:** [GeneralUpdate-Samples / Bowl](https://github.com/GeneralLibrary/GeneralUpdate-Samples/tree/main/src/Bowl) |
Comment on lines
+280
to
+284
| 旧示例中的 `GeneralUpdate.Bowl.Strategys.MonitorParameter` 已标记为过时，推荐迁移到 `BowlContext` 和异步入口： | ||
|
|
||
| | 产品 | 版本 | | ||
| | --------------- | ----------------- | | ||
| | .NET | 5, 6, 7, 8, 9, 10 | | ||
| | .NET Framework | 4.6.1 | | ||
| | .NET Standard | 2.0 | | ||
| | .NET Core | 2.0 | | ||
| | ASP.NET | Any | | ||
| ```csharp | ||
| var oldParameter = new GeneralUpdate.Bowl.Strategys.MonitorParameter | ||
| { |
| - **示例代码**：[查看 GitHub 示例](https://github.com/GeneralLibrary/GeneralUpdate-Samples/tree/main/src/Bowl) | ||
| - **视频教程**：[观看 Bilibili 教程](https://www.bilibili.com/video/BV1c8iyYZE7P) | ||
| - **主仓库**：[GeneralUpdate 项目](https://github.com/GeneralLibrary/GeneralUpdate) | ||
| - **示例代码**：[GeneralUpdate-Samples / Bowl](https://github.com/GeneralLibrary/GeneralUpdate-Samples/tree/main/src/Bowl) |
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.
Refs #48
Summary
Validation