Skip to content

docs: update Core & Differential docs and sync i18n across all locales #87

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JusterZhu merged 4 commits into from
Jun 4, 2026
Merged

docs: update Core & Differential docs and sync i18n across all locales #87

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
37e883e
docs: update Core & Differential docs and sync i18n across all locales
JusterZhu Jun 4, 2026
f985c07
fix: remove redundant zh-Hans i18n overrides causing MDX build failure
JusterZhu Jun 4, 2026
01ad34f
fix: remove <br> tags in SetSource table row causing MDX compilation …
JusterZhu Jun 4, 2026
9909476
fix: remove .md suffix from all internal Docusaurus links
JusterZhu Jun 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion website/docs/doc/GeneralUpdate.Bowl.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -417,4 +417,4 @@ MyApp/

- [Bowl 示例代码](https://github.com/GeneralLibrary/GeneralUpdate-Samples/tree/main/src/Bowl)
- [GeneralUpdate 仓库](https://github.com/GeneralLibrary/GeneralUpdate)
- [Dump 指南](../guide/Dump.md)
- [Dump 指南](../guide/Dump)
9 changes: 6 additions & 3 deletions website/docs/doc/GeneralUpdate.Core.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ sidebar_position: 5
| `Cancel()` | 无 | `void` | UI 中提供"取消更新"按钮 | 触发内部 `CancellationTokenSource` |
| `SetConfig(UpdateRequest)` | `configInfo` — 更新配置对象 | `GeneralUpdateBootstrap` | 主程序内显式配置更新参数 | 会调用 `Validate()` 检查关键字段 |
| `SetConfig(string)` | `filePath` — JSON 配置文件路径 | `GeneralUpdateBootstrap` | 从文件读取更新配置 | 支持相对路径和绝对路径；UTF-8 JSON 格式 |
| `SetSource(...)` | `updateUrl`, `appSecretKey`, `reportUrl?`, `scheme?`, `token?` | `GeneralUpdateBootstrap` | 轻配置入口，配合 manifest 使用 | 只提供服务端入口和密钥，身份信息由 manifest 补齐 |
| `SetSource(...)` | `updateUrl`, `appSecretKey`, `reportUrl?`, `scheme?`, `token?`, `authScheme?`, `basicUsername?`, `basicPassword?`, `installPath?` | `GeneralUpdateBootstrap` | 轻配置入口，配合 manifest 使用 | 只提供服务端入口和密钥，身份信息由 manifest 补齐；支持 HMAC / Bearer / Basic 多种认证方式 |
| `SetOption(Option<T>, T)` | `option` — 选项键, `value` — 选项值 | `GeneralUpdateBootstrap` | 设置运行时选项 | 传入 `null` 给可空选项会移除当前设置 |
| `UseDiffPipeline(Action<DiffPipelineBuilder>)` | `configure` — 差分管道配置委托 | `GeneralUpdateBootstrap` | 替换或调整差分补丁管道 | 未调用时使用默认配置 |
| `AddListenerUpdateInfo(...)` | `EventHandler<UpdateInfoEventArgs>` | `GeneralUpdateBootstrap` | 接收服务端版本信息 | 无更新时也会触发（`Info.Code = 404`） |
Expand Down Expand Up @@ -197,6 +197,9 @@ sidebar_position: 5
| `SetDriverDirectory(string)` | `path` | `UpdateRequestBuilder` | 设置驱动目录 | — |
| `SetScheme(string)` | `scheme` | `UpdateRequestBuilder` | 设置认证方案 | — |
| `SetToken(string)` | `token` | `UpdateRequestBuilder` | 设置认证令牌 | — |
| `SetAuthScheme(AuthScheme)` | `authScheme` — 认证方案枚举 | `UpdateRequestBuilder` | 设置认证方案（Hmac / Bearer / ApiKey / Basic） | 默认 `Hmac` |
| `SetBasicUsername(string)` | `username` | `UpdateRequestBuilder` | 设置 Basic 认证用户名 | 需配合 `SetAuthScheme(AuthScheme.Basic)` |
| `SetBasicPassword(string)` | `password` | `UpdateRequestBuilder` | 设置 Basic 认证密码 | 需配合 `SetAuthScheme(AuthScheme.Basic)` |
| `SetFiles(List<string>)` | `files` | `UpdateRequestBuilder` | 设置跳过文件列表 | — |
| `SetFormats(List<string>)` | `formats` | `UpdateRequestBuilder` | 设置跳过扩展名列表 | — |
| `SetDirectories(List<string>)` | `dirs` | `UpdateRequestBuilder` | 设置跳过目录列表 | — |
Expand Down Expand Up @@ -1007,5 +1010,5 @@ var failedVersion = Environments.Get("UpgradeFail");
- [GeneralUpdate 仓库](https://github.com/GeneralLibrary/GeneralUpdate)
- [Samples 示例代码](https://github.com/GeneralLibrary/GeneralUpdate-Samples)
- [GeneralUpdate.Tools](https://github.com/GeneralLibrary/GeneralUpdate.Tools)
- [入门实战手册](../quickstart/Beginner%20cookbook.md)
- [组件文档](./GeneralUpdate.Core.md)
- [入门实战手册](../quickstart/Beginner%20cookbook)
- [组件文档](./GeneralUpdate.Core)
10 changes: 5 additions & 5 deletions website/docs/doc/GeneralUpdate.Differential.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ sidebar_position: 6

### 1.1 组件概述

**GeneralUpdate.Differential** 是 GeneralUpdate 的二进制差分组件，专注解决"一个旧文件 + 一个补丁文件 = 一个新文件"的问题。它提供可替换的文件级差分算法（BSDIFF 4.0 / Streaming HDiff）、补丁压缩抽象（BZip2 / Deflate / Brotli 预留）和 BSDIFF 兼容补丁读写能力。
**GeneralUpdate.Differential** 是 GeneralUpdate 的二进制差分组件，专注解决"一个旧文件 + 一个补丁文件 = 一个新文件"的问题。它提供可替换的文件级差分算法（BSDIFF 4.0 / Streaming HDiff）、补丁压缩抽象（BZip2 / Deflate，源码中预留 .NET 6+ Brotli）和 BSDIFF 兼容补丁读写能力。

目录级对比、批量补丁生成、并行调度、删除文件处理和更新流程编排由 `GeneralUpdate.Core` 的 `DiffPipeline` 或 `GeneralUpdate.Tools` 承担。

Expand All @@ -21,7 +21,7 @@ sidebar_position: 6
| 文件级差分生成 | `CleanAsync(oldFile, newFile, patchFile)` — 对比新旧文件生成 `.patch` 补丁 |
| 文件级差分应用 | `DirtyAsync(oldFile, newFile, patchFile)` — 旧文件 + 补丁 → 新文件 |
| 可替换差分算法 | `BsdiffDiffer`（BSDIFF 4.0，后缀排序）和 `StreamingHdiffDiffer`（块哈希索引） |
| 可替换压缩格式 | BZip2 (0x00)、Deflate (0x01)，源码中预留 .NET 6+ Brotli (0x02) |
| 可替换压缩格式 | BZip2 (0x00)、Deflate (0x01)，源码中通过 `#if NET6_0_OR_GREATER` 条件编译预留 Brotli (0x02) |
| BSDIFF 兼容格式 | 写入 33 字节扩展头（32 字节 BSDIFF40 + 1 字节压缩格式），兼容 32 字节旧头 |
| 线程安全 | 内置 differ 和压缩提供器均支持并发调用 |

Expand Down Expand Up @@ -93,7 +93,7 @@ Differential 本身是底层库，不提供配置类。所有参数通过构造
| --- | --- | --- | --- |
| `BZip2CompressionProvider` | `0x00` | 完全可用 | BSDIFF 旧补丁兼容，解压成本较高 |
| `DeflateCompressionProvider` | `0x01` | 完全可用 | 解压速度更友好，适合客户端批量应用 |
| `BrotliCompressionProvider` | `0x02` | 仅 .NET 6+ 编译（源码预留） | 生产不建议使用 |
| `BrotliCompressionProvider` | `0x02` | 仅 .NET 6+ 编译（源码中为完整实现，通过 `#if NET6_0_OR_GREATER` 条件编译） | 当前 `netstandard2.0` 包中不包含，生产不建议使用 |

### 3.2 实例方法

Expand Down Expand Up @@ -363,5 +363,5 @@ await new GeneralUpdateBootstrap()

- [GeneralUpdate 仓库](https://github.com/GeneralLibrary/GeneralUpdate)
- [Samples 差分示例](https://github.com/GeneralLibrary/GeneralUpdate-Samples/tree/main/src/Hub/Samples/DifferentialSample.cs)
- [Core DiffPipeline 文档](GeneralUpdate.Core.md)
- [Tools 打包指南](../guide/Packaging.md)
- [Core DiffPipeline 文档](GeneralUpdate.Core)
- [Tools 打包指南](../guide/Packaging)
2 changes: 1 addition & 1 deletion website/docs/doc/GeneralUpdate.Drivelution.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -554,4 +554,4 @@ GeneralTracer.SetTracingEnabled(true);

- [驱动更新示例](https://github.com/GeneralLibrary/GeneralUpdate-Samples/tree/main/src/Hub/Samples/ImDiskQuickInstallSample.cs)
- [GeneralUpdate 仓库](https://github.com/GeneralLibrary/GeneralUpdate)
- [GeneralUpdate.Drivelution 组件文档](../doc/GeneralUpdate.Drivelution.md)
- [GeneralUpdate.Drivelution 组件文档](../doc/GeneralUpdate.Drivelution)
2 changes: 1 addition & 1 deletion website/docs/doc/GeneralUpdate.Extension.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -676,4 +676,4 @@ report-extension_1.0.0.zip

- [扩展管理示例](https://github.com/GeneralLibrary/GeneralUpdate-Samples/tree/main/src/Hub/Samples/ExtensionSample.cs)
- [GeneralUpdate 仓库](https://github.com/GeneralLibrary/GeneralUpdate)
- [打包指南](../guide/Packaging.md)
- [打包指南](../guide/Packaging)
2 changes: 1 addition & 1 deletion website/docs/doc/UpgradeHub.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -363,4 +363,4 @@ await new GeneralClientBootstrap()

- **示例代码：** [查看 GitHub 示例](https://github.com/GeneralLibrary/GeneralUpdate-Samples/blob/main/src/Push/Program.cs)
- **主仓库：** [GeneralUpdate 项目](https://github.com/GeneralLibrary/GeneralUpdate)
- **相关组件：** [GeneralUpdate.Core](./GeneralUpdate.Core.md) | [GeneralUpdate.Core](./GeneralUpdate.Core.md)
- **相关组件：** [GeneralUpdate.Core](./GeneralUpdate.Core) | [GeneralUpdate.Core](./GeneralUpdate.Core)
8 changes: 4 additions & 4 deletions website/docs/guide/FAQ.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -332,7 +332,7 @@ await new GeneralClientBootstrap()

## 相关资源

- **[GeneralUpdate.Core](../doc/GeneralUpdate.Core.md)** — 核心更新引擎
- **[入门实战手册](../quickstart/Beginner%20cookbook.md)** — 从零跑通更新闭环
- **[GeneralUpdate.Tools](../quickstart/GeneralUpdate.PacketTool.md)** — 打包工具
- **[GeneralUpdate.Bowl](../doc/GeneralUpdate.Bowl.md)** — 崩溃监控与回滚
- **[GeneralUpdate.Core](../doc/GeneralUpdate.Core)** — 核心更新引擎
- **[入门实战手册](../quickstart/Beginner%20cookbook)** — 从零跑通更新闭环
- **[GeneralUpdate.Tools](../quickstart/GeneralUpdate.PacketTool)** — 打包工具
- **[GeneralUpdate.Bowl](../doc/GeneralUpdate.Bowl)** — 崩溃监控与回滚
8 changes: 4 additions & 4 deletions website/docs/guide/Packaging.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ await new GeneralUpdateBootstrap()
**避免 C 盘权限问题：**

- 建议默认安装到 `%LOCALAPPDATA%` 而非 `C:\Program Files\`
- 如必须安装在 C 盘，参考 [权限指南](./Permission.md) 配置注册表降权
- 如必须安装在 C 盘，参考 [权限指南](./Permission) 配置注册表降权

**Windows 发布命令：**

Expand Down Expand Up @@ -280,6 +280,6 @@ jobs:
## 相关资源

- **[GeneralUpdate.Tools](../quickstart/GeneralUpdate.PacketTool)** — 补丁包和配置生成工具
- **[权限指南](./Permission.md)** — Windows UAC 权限处理
- **[入门实战手册](../quickstart/Beginner%20cookbook.md)** — 从零跑通更新闭环
- **[GeneralUpdate.Core](../doc/GeneralUpdate.Core.md)** — 核心更新引擎架构
- **[权限指南](./Permission)** — Windows UAC 权限处理
- **[入门实战手册](../quickstart/Beginner%20cookbook)** — 从零跑通更新闭环
- **[GeneralUpdate.Core](../doc/GeneralUpdate.Core)** — 核心更新引擎架构
22 changes: 11 additions & 11 deletions website/docs/quickstart/Beginner cookbook.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,12 @@ title: 入门实战手册

| 角色 | 在样例中的位置 | 负责什么 | 深入阅读 |
| --- | --- | --- | --- |
| Hub | `src\Hub` | 交互式示例浏览器，通过菜单选择并运行各类更新场景 | [GeneralUpdate.Core](../doc/GeneralUpdate.Core.md) |
| Server | `src\Server` | 返回版本信息、接收更新报告、提供补丁下载 | [GeneralUpdate.Core](../doc/GeneralUpdate.Core.md) |
| Packet | `src\Server\wwwroot\packages` | 可下载的 `.zip` 更新包和 `versions.json` 元数据 | [GeneralUpdate.Tools](./GeneralUpdate.PacketTool.md) |
| Tools | GeneralUpdate.Tools 仓库 | 生成补丁包、Hash、OSS 清单、manifest 和仿真报告 | [GeneralUpdate.Tools](./GeneralUpdate.PacketTool.md) |
| Bowl | Hub Samples 中集成 | 监控进程异常并导出失败信息 | [GeneralUpdate.Bowl](../doc/GeneralUpdate.Bowl.md) |
| Differential | Hub Samples + Core 默认集成 | 对 old/new 文件生成差分，并在更新阶段应用 | [GeneralUpdate.Differential](../doc/GeneralUpdate.Differential.md) |
| Hub | `src\Hub` | 交互式示例浏览器，通过菜单选择并运行各类更新场景 | [GeneralUpdate.Core](../doc/GeneralUpdate.Core) |
| Server | `src\Server` | 返回版本信息、接收更新报告、提供补丁下载 | [GeneralUpdate.Core](../doc/GeneralUpdate.Core) |
| Packet | `src\Server\wwwroot\packages` | 可下载的 `.zip` 更新包和 `versions.json` 元数据 | [GeneralUpdate.Tools](./GeneralUpdate.PacketTool) |
| Tools | GeneralUpdate.Tools 仓库 | 生成补丁包、Hash、OSS 清单、manifest 和仿真报告 | [GeneralUpdate.Tools](./GeneralUpdate.PacketTool) |
| Bowl | Hub Samples 中集成 | 监控进程异常并导出失败信息 | [GeneralUpdate.Bowl](../doc/GeneralUpdate.Bowl) |
| Differential | Hub Samples + Core 默认集成 | 对 old/new 文件生成差分，并在更新阶段应用 | [GeneralUpdate.Differential](../doc/GeneralUpdate.Differential) |

## Step 1：准备仓库和运行环境

Expand Down Expand Up @@ -239,11 +239,11 @@ Hub 提供了 9 个内置样例，覆盖了 GeneralUpdate 的主要使用场景

跑通这条链路后，建议按顺序阅读：

1. [GeneralUpdate.Core](../doc/GeneralUpdate.Core.md)：更新策略、事件通知、静默更新、manifest 极简配置。
2. [GeneralUpdate.Tools](./GeneralUpdate.PacketTool.md)：补丁包、Hash、OSS Config、Simulation。
3. [GeneralUpdate.Differential](../doc/GeneralUpdate.Differential.md)：差分算法、并行处理和 Clean/Dirty。
4. [GeneralUpdate.Bowl](../doc/GeneralUpdate.Bowl.md)：崩溃监控、备份和失败恢复。
5. [GeneralUpdate.Tools](./GeneralUpdate.PacketTool.md)：补丁包、Hash、OSS Config、Simulation。
1. [GeneralUpdate.Core](../doc/GeneralUpdate.Core)：更新策略、事件通知、静默更新、manifest 极简配置。
2. [GeneralUpdate.Tools](./GeneralUpdate.PacketTool)：补丁包、Hash、OSS Config、Simulation。
3. [GeneralUpdate.Differential](../doc/GeneralUpdate.Differential)：差分算法、并行处理和 Clean/Dirty。
4. [GeneralUpdate.Bowl](../doc/GeneralUpdate.Bowl)：崩溃监控、备份和失败恢复。
5. [GeneralUpdate.Tools](./GeneralUpdate.PacketTool)：补丁包、Hash、OSS Config、Simulation。

## Sample UI

Expand Down
12 changes: 6 additions & 6 deletions website/docs/quickstart/GeneralUpdate.PacketTool.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ dotnet run --project GeneralUpdate.Tools.csproj

- Extension Host 调用 `ExtensionManager.QueryRemoteExtensionsAsync(...)` 获取扩展列表
- 安装时下载 ZIP，读取 `manifest.json` 进行兼容性检查和依赖解析
- 详见 [GeneralUpdate.Extension](../doc/GeneralUpdate.Extension.md)
- 详见 [GeneralUpdate.Extension](../doc/GeneralUpdate.Extension)

---

Expand Down Expand Up @@ -189,7 +189,7 @@ dotnet run --project GeneralUpdate.Tools.csproj

- 将 `oss_config.json` 上传到 OSS bucket 或静态文件服务器
- OSS 客户端读取此文件发现可用版本，下载后校验 Hash
- 详见 [GeneralUpdate.Core](../doc/GeneralUpdate.Core.md) OSS 更新策略
- 详见 [GeneralUpdate.Core](../doc/GeneralUpdate.Core) OSS 更新策略

---

Expand Down Expand Up @@ -349,7 +349,7 @@ Generate Sample 额外输出：

## 关联文档

- [GeneralUpdate.Core](../doc/GeneralUpdate.Core.md)：Client/Upgrade 更新主流程
- [GeneralUpdate.Differential](../doc/GeneralUpdate.Differential.md)：差分算法 Clean/Dirty 模式
- [GeneralUpdate.Extension](../doc/GeneralUpdate.Extension.md)：扩展包安装与版本管理
- [入门实战手册](./Beginner%20cookbook.md)：从零跑通完整更新闭环
- [GeneralUpdate.Core](../doc/GeneralUpdate.Core)：Client/Upgrade 更新主流程
- [GeneralUpdate.Differential](../doc/GeneralUpdate.Differential)：差分算法 Clean/Dirty 模式
- [GeneralUpdate.Extension](../doc/GeneralUpdate.Extension)：扩展包安装与版本管理
- [入门实战手册](./Beginner%20cookbook)：从零跑通完整更新闭环
2 changes: 1 addition & 1 deletion website/i18n/en/docusaurus-plugin-content-docs/current/doc/GeneralUpdate.Bowl.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -362,4 +362,4 @@ MyApp/

- [Bowl Sample Code](https://github.com/GeneralLibrary/GeneralUpdate-Samples/tree/main/src/Bowl)
- [GeneralUpdate Repository](https://github.com/GeneralLibrary/GeneralUpdate)
- [Dump Guide](../guide/Dump.md)
- [Dump Guide](../guide/Dump)
11 changes: 7 additions & 4 deletions website/i18n/en/docusaurus-plugin-content-docs/current/doc/GeneralUpdate.Core.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,8 +98,11 @@ sidebar_position: 5
| `ProductId` | `string` | — | Optional | — | Product identifier for multi-product servers |
| `UpdatePath` | `string` | `InstallPath` | Optional | Valid directory path | Upgrade process location |
| `Bowl` | `string` | `null` | Optional | Valid filename | Auxiliary process name to close before update |
| `Scheme` | `string` | `null` | Optional | `"Bearer"` etc. | Auth scheme |
| `Scheme` | `string` | `null` | Optional | `"Bearer"` etc. | Auth scheme (used with `Token`) |
| `Token` | `string` | `null` | Optional | — | Auth token |
| `AuthScheme` | `AuthScheme` | `Hmac` | Optional | `Hmac`, `Bearer`, `Basic` | Auth scheme enum; `Hmac` for GeneralSpacestation server-side signed auth |
| `BasicUsername` | `string` | `null` | Optional | — | HTTP Basic auth username (requires `AuthScheme = Basic`) |
| `BasicPassword` | `string` | `null` | Optional | — | HTTP Basic auth password (requires `AuthScheme = Basic`) |
Comment on lines 99 to +105
| `Files` | `List<string>` | `null` | Optional | — | Files to skip during update |
| `Formats` | `List<string>` | `null` | Optional | — | Extensions to skip during update |
| `Directories` | `List<string>` | `null` | Optional | — | Directories to skip during update |
Expand Down Expand Up @@ -135,7 +138,7 @@ sidebar_position: 5
| `Cancel()` | None | `void` | UI "Cancel Update" button | Triggers internal `CancellationTokenSource` |
| `SetConfig(UpdateRequest)` | `configInfo` | `GeneralUpdateBootstrap` | Explicit update configuration | Calls `Validate()` on key fields |
| `SetConfig(string)` | `filePath` — JSON config file path | `GeneralUpdateBootstrap` | Read config from file | Supports relative/absolute paths; UTF-8 JSON |
| `SetSource(...)` | `updateUrl`, `appSecretKey`, `reportUrl?`, `scheme?`, `token?` | `GeneralUpdateBootstrap` | Lightweight entry with manifest | Identity info filled by manifest |
| `SetSource(...)` | `updateUrl`, `appSecretKey`, `reportUrl?`, `scheme?`, `token?`, `authScheme?`, `basicUsername?`, `basicPassword?`, `installPath?` | `GeneralUpdateBootstrap` | Lightweight entry with manifest | Identity info filled by manifest; supports HMAC / Bearer / Basic auth methods |
| `SetOption(Option<T>, T)` | `option` — key, `value` — value | `GeneralUpdateBootstrap` | Set runtime options | Pass `null` to reset nullable options |
| `UseDiffPipeline(Action<DiffPipelineBuilder>)` | `configure` — delegate | `GeneralUpdateBootstrap` | Replace or tune diff pipeline | Default used if not called |
| `AddListenerUpdateInfo(...)` | `EventHandler<UpdateInfoEventArgs>` | `GeneralUpdateBootstrap` | Receive server version info | Also fires when no update available |
Expand Down Expand Up @@ -664,5 +667,5 @@ GeneralTracer.Dispose();
- [GeneralUpdate Repository](https://github.com/GeneralLibrary/GeneralUpdate)
- [Samples Code](https://github.com/GeneralLibrary/GeneralUpdate-Samples)
- [GeneralUpdate.Tools](https://github.com/GeneralLibrary/GeneralUpdate.Tools)
- [Beginner Cookbook](../quickstart/Beginner%20cookbook.md)
- [Component docs](./GeneralUpdate.Core.md)
- [Beginner Cookbook](../quickstart/Beginner%20cookbook)
- [Component docs](./GeneralUpdate.Core)
8 changes: 4 additions & 4 deletions ...18n/en/docusaurus-plugin-content-docs/current/doc/GeneralUpdate.Differential.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Directory-level comparison, batch patch generation, parallel scheduling, deleted
| File-Level Diff Generation | `CleanAsync(oldFile, newFile, patchFile)` — compare old & new files to generate `.patch` |
| File-Level Diff Application | `DirtyAsync(oldFile, newFile, patchFile)` — old file + patch → new file |
| Pluggable Diff Algorithms | `BsdiffDiffer` (BSDIFF 4.0, suffix sort) and `StreamingHdiffDiffer` (block hash indexing) |
| Pluggable Compression | BZip2 (0x00), Deflate (0x01), .NET 6+ Brotli (0x02) reserved in source |
| Pluggable Compression | BZip2 (0x00), Deflate (0x01), .NET 6+ Brotli (0x02) available via conditional compilation |
| BSDIFF Compatible Format | 33-byte extended header (32-byte BSDIFF40 + 1-byte compression format), 32-byte legacy compatible |
| Thread Safety | Built-in differ and compression providers support concurrent calls |

Expand Down Expand Up @@ -87,7 +87,7 @@ Differential is a low-level library with no configuration classes. All parameter
| --- | --- | --- | --- |
| `BZip2CompressionProvider` | `0x00` | Fully available | Legacy BSDIFF compatible, higher decompression cost |
| `DeflateCompressionProvider` | `0x01` | Fully available | Faster decompression, better for client batch apply |
| `BrotliCompressionProvider` | `0x02` | .NET 6+ only (source reserved) | Not recommended for production |
| `BrotliCompressionProvider` | `0x02` | .NET 6+ only (full implementation in source behind `#if NET6_0_OR_GREATER` conditional compilation) | Not included in current `netstandard2.0` package; not recommended for production |

### 3.2 Instance Methods

Expand Down Expand Up @@ -287,5 +287,5 @@ await new GeneralUpdateBootstrap()

- [GeneralUpdate Repository](https://github.com/GeneralLibrary/GeneralUpdate)
- [Differential Sample](https://github.com/GeneralLibrary/GeneralUpdate-Samples/tree/main/src/Hub/Samples/DifferentialSample.cs)
- [Core DiffPipeline Docs](GeneralUpdate.Core.md)
- [Packaging Guide](../guide/Packaging.md)
- [Core DiffPipeline Docs](GeneralUpdate.Core)
- [Packaging Guide](../guide/Packaging)
2 changes: 1 addition & 1 deletion ...i18n/en/docusaurus-plugin-content-docs/current/doc/GeneralUpdate.Drivelution.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -354,4 +354,4 @@ GeneralTracer.SetTracingEnabled(true); // Re-enable for troubleshooting

- [Driver Update Sample](https://github.com/GeneralLibrary/GeneralUpdate-Samples/tree/main/src/Hub/Samples/ImDiskQuickInstallSample.cs)
- [GeneralUpdate Repository](https://github.com/GeneralLibrary/GeneralUpdate)
- [GeneralUpdate.Drivelution docs](../doc/GeneralUpdate.Drivelution.md)
- [GeneralUpdate.Drivelution docs](../doc/GeneralUpdate.Drivelution)
Loading
Loading