docs: add Core-execution-flow page with architecture flowcharts#132
Merged
Conversation
New 'Core-execution-flow' page provides a comprehensive deep-dive into GeneralUpdate.Core's execution architecture, covering: - Three-layer dispatch design (Bootstrap → RoleStrategy → OSStrategy) - Complete ClientStrategy workflow with flowcharts - DownloadPlanBuilder Chain vs Full decision logic (80% threshold) - Middleware pipeline (Hash → Compress → Patch) execution differences - DiffPipeline differential engine internals (CleanAsync/DirtyAsync) - Chain-to-Full fallback mechanism with version tracking - IPC communication protocol (AES-256-CBC encrypted) - UpdateStrategy Upgrade-process execution flow - Silent Mode delayed-upgrade design - OS strategy platform differences - Error recovery panorama (13 error scenarios) - Key code path index with source links Placed in Components sidebar, directly after GeneralUpdate.Core. Co-Authored-By: Claude <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
This PR adds a new “Core-execution-flow” documentation page describing the internal execution flow/architecture of GeneralUpdate.Core, and wires it into the Docusaurus sidebar under Components (after GeneralUpdate.Core).
Changes:
- Add new Core execution-flow doc page (with many Mermaid flowcharts) under
website/docs/doc/. - Add an English-locale counterpart under
website/i18n/en/...(currently same Chinese content). - Insert the new doc entry into
website/sidebars.jsunder the Components section.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
| website/sidebars.js | Adds the new doc id to the Components sidebar list. |
| website/docs/doc/Core-execution-flow.md | New Chinese doc page describing Core execution flow with flowcharts and code-path index. |
| website/i18n/en/docusaurus-plugin-content-docs/current/doc/Core-execution-flow.md | New English-locale page (currently Chinese content) mirroring the new doc. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+203
to
+205
| ```mermaid | ||
| flowchart TB | ||
| subgraph CLIENT["ClientStrategy 执行流程"] |
Comment on lines
+5
to
+8
| # GeneralUpdate.Core — 执行流程详解 | ||
|
|
||
| > **目标读者：** 第一次接触 GeneralUpdate.Core 的开发者 | ||
| > |
Comment on lines
+203
to
+205
| ```mermaid | ||
| flowchart TB | ||
| subgraph CLIENT["ClientStrategy 执行流程"] |
| | 步骤 | 文件 | 关键行 | | ||
| |------|------|--------| | ||
| | 入口分发 | `Bootstrap/GeneralUpdateBootstrap.cs` | `LaunchAsync()` @L125 | | ||
| | Upgade 路径 IPC 读取 | `Bootstrap/GeneralUpdateBootstrap.cs` | `InitializeFromEnvironment()` @L357 | |
| | 步骤 | 文件 | 关键行 | | ||
| |------|------|--------| | ||
| | 入口分发 | `Bootstrap/GeneralUpdateBootstrap.cs` | `LaunchAsync()` @L125 | | ||
| | Upgade 路径 IPC 读取 | `Bootstrap/GeneralUpdateBootstrap.cs` | `InitializeFromEnvironment()` @L357 | |
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.
变更内容
新增 Core-execution-flow 页面到在线文档的 Components 分类，紧接 @GeneralUpdate.Core 之后。
新增页面内容
改动文件
website/docs/doc/Core-execution-flow.md— 主文档（中文，默认语言）website/i18n/en/docusaurus-plugin-content-docs/current/doc/Core-execution-flow.md— 英文版（内容相同，待翻译）website/sidebars.js— Components 列表插入新条目导航位置
Co-Authored-By: Claude noreply@anthropic.com