Conversation
…t PRs - Add AddListenerUpdateInfo() method documentation (PR #166) - Add AddListenerUpdatePrecheck() replacing SetCustomSkipOption (PR #172) - Remove deprecated SetCustomSkipOption from ClientCore docs - Add UpdateOption.EnableSilentUpdate for silent update mode (PR #164) - Add ConfiginfoBuilder zero-configuration builder section (PR #157) - Add DriverDirectory field to Configinfo documentation (PR #145) - Remove SetFieldMappings from Core docs (PR #148) - Update driver upgrade example to use new DriverDirectory approach - Add new examples for precheck, silent update, and ConfiginfoBuilder - Add 2026-04-10 release log entries in English and Chinese - All changes applied to docs/, i18n/zh-Hans/, and i18n/en/" Agent-Logs-Url: https://github.com/GeneralLibrary/GeneralUpdate-Samples/sessions/1116c9d1-3933-4783-83a9-842784e0e6bd Co-authored-by: JusterZhu <11714536+JusterZhu@users.noreply.github.com>
|
@copilot 检查全局有没有文档和现有代码不一样的地方进行补充或更改。 |
- Add DriverDirectory to Packet class in Core.md (all 3 copies) - Update .NET version tables to include .NET 10 in Bowl, Core, Differential, Drivelution, GeneralClient.OSS, UpgradeHub docs (all 3 copies each) - Fix malformed version string '9,10' -> '9, 10' in zh-Hans GeneralTracer.md Agent-Logs-Url: https://github.com/GeneralLibrary/GeneralUpdate-Samples/sessions/eacb5b23-1edb-47a0-a533-95ac3b940688 Co-authored-by: JusterZhu <11714536+JusterZhu@users.noreply.github.com>
已完成全局检查,发现并修复了以下文档与现有代码不一致的地方(commit
|
There was a problem hiding this comment.
Pull request overview
Updates the Docusaurus website documentation (default + i18n zh-Hans/en) to reflect recently merged GeneralUpdate API changes and to refresh version-compatibility tables.
Changes:
- Document new ClientCore APIs (
AddListenerUpdatePrecheck, updatedAddListenerUpdateInfo), silent update option,ConfiginfoBuilder, andDriverDirectoryflow. - Update Core driver-upgrade docs to use
Configinfo.DriverDirectoryand removeSetFieldMappingsdocs. - Add
.NET 10to compatibility tables and add a 2026-04-10 release log entry (zh/en).
Reviewed changes
Copilot reviewed 24 out of 25 changed files in this pull request and generated 8 comments.
Show a summary per file
| File | Description |
|---|---|
| website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/releaselog/GeneralUpdateReleaselog.md | Adds 2026-04-10 zh-Hans release log entry describing the new APIs/behaviors. |
| website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/doc/UpgradeHub.md | Updates zh-Hans compatibility table to include .NET 10. |
| website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/doc/GeneralUpdate.Drivelution.md | Updates zh-Hans compatibility table to include .NET 10. |
| website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/doc/GeneralUpdate.Differential.md | Updates zh-Hans compatibility table to include .NET 10. |
| website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/doc/GeneralUpdate.Core.md | Removes SetFieldMappings docs; documents Packet.DriverDirectory and driver-upgrade configuration via Configinfo.DriverDirectory (zh-Hans). |
| website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/doc/GeneralUpdate.ClientCore.md | Documents new ClientCore APIs, silent update, DriverDirectory, and ConfiginfoBuilder (zh-Hans). |
| website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/doc/GeneralUpdate.Bowl.md | Updates zh-Hans compatibility table to include .NET 10. |
| website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/doc/GeneralTracer.md | Fixes zh-Hans version string formatting (9,10 → 9, 10). |
| website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/doc/GeneralClient.OSS.md | Updates zh-Hans compatibility table to include .NET 10. |
| website/i18n/en/docusaurus-plugin-content-docs/current/releaselog/GeneralUpdateReleaselog.md | Adds 2026-04-10 en release log entry describing the new APIs/behaviors. |
| website/i18n/en/docusaurus-plugin-content-docs/current/doc/UpgradeHub.md | Updates en compatibility table to include .NET 10. |
| website/i18n/en/docusaurus-plugin-content-docs/current/doc/GeneralUpdate.Drivelution.md | Updates en compatibility table to include .NET 10. |
| website/i18n/en/docusaurus-plugin-content-docs/current/doc/GeneralUpdate.Differential.md | Updates en compatibility table to include .NET 10. |
| website/i18n/en/docusaurus-plugin-content-docs/current/doc/GeneralUpdate.Core.md | Removes SetFieldMappings docs; documents Packet.DriverDirectory and driver-upgrade configuration via Configinfo.DriverDirectory (en). |
| website/i18n/en/docusaurus-plugin-content-docs/current/doc/GeneralUpdate.ClientCore.md | Documents new ClientCore APIs, silent update, DriverDirectory, and ConfiginfoBuilder (en). |
| website/i18n/en/docusaurus-plugin-content-docs/current/doc/GeneralUpdate.Bowl.md | Updates en compatibility table to include .NET 10. |
| website/i18n/en/docusaurus-plugin-content-docs/current/doc/GeneralClient.OSS.md | Updates en compatibility table to include .NET 10. |
| website/docs/releaselog/GeneralUpdateReleaselog.md | Adds 2026-04-10 release log entry describing the new APIs/behaviors (default docs). |
| website/docs/doc/UpgradeHub.md | Updates compatibility table to include .NET 10 (default docs). |
| website/docs/doc/GeneralUpdate.Drivelution.md | Updates compatibility table to include .NET 10 (default docs). |
| website/docs/doc/GeneralUpdate.Differential.md | Updates compatibility table to include .NET 10 (default docs). |
| website/docs/doc/GeneralUpdate.Core.md | Removes SetFieldMappings docs; documents Packet.DriverDirectory and driver-upgrade configuration via Configinfo.DriverDirectory (default docs). |
| website/docs/doc/GeneralUpdate.ClientCore.md | Documents new ClientCore APIs, silent update, DriverDirectory, and ConfiginfoBuilder (default docs). |
| website/docs/doc/GeneralUpdate.Bowl.md | Updates compatibility table to include .NET 10 (default docs). |
| website/docs/doc/GeneralClient.OSS.md | Updates compatibility table to include .NET 10 (default docs). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ```csharp | ||
| .AddListenerUpdateInfo((sender, e) => | ||
| { | ||
| foreach (var v in e.Info.Body ?? []) |
There was a problem hiding this comment.
The e.Info.Body ?? [] fallback uses C# collection expressions, which won’t compile on many setups (e.g., projects still using older C# for .NET 5/6). Consider using a more broadly compatible empty-sequence fallback so the sample compiles across the supported target versions.
| foreach (var v in e.Info.Body ?? []) | |
| if (e.Info.Body == null) | |
| return; | |
| foreach (var v in e.Info.Body) |
| ```csharp | ||
| using GeneralUpdate.Common.Shared.Object; | ||
|
|
||
| // 零配置:从 .csproj 自动提取名称、版本、发布者 | ||
| var config = ConfiginfoBuilder | ||
| .Create("https://api.example.com/updates", "your-token", "Bearer") | ||
| .Build(); | ||
|
|
||
| await new GeneralClientBootstrap() | ||
| .SetConfig(config) | ||
| .LaunchAsync(); | ||
| ``` | ||
|
|
||
| ### 自定义覆盖 |
There was a problem hiding this comment.
This ConfiginfoBuilder “Quick Usage” snippet uses GeneralClientBootstrap but only imports GeneralUpdate.Common.Shared.Object; it will not compile without also importing the GeneralUpdate.ClientCore namespace (or fully-qualifying the type). Please make the snippet self-contained by adding the missing import.
| ```csharp | ||
| .AddListenerUpdateInfo((sender, e) => | ||
| { | ||
| foreach (var v in e.Info.Body ?? []) |
There was a problem hiding this comment.
The e.Info.Body ?? [] fallback uses C# collection expressions, which won’t compile on many setups (e.g., projects still using older C# for .NET 5/6). Consider using a more broadly compatible empty-sequence fallback so the sample compiles across the supported target versions.
| foreach (var v in e.Info.Body ?? []) | |
| foreach (var v in e.Info.Body ?? Enumerable.Empty<VersionRespDTO>()) |
| ```csharp | ||
| using GeneralUpdate.Common.Shared.Object; | ||
|
|
||
| // Zero-configuration: name, version, and publisher auto-extracted from .csproj | ||
| var config = ConfiginfoBuilder | ||
| .Create("https://api.example.com/updates", "your-token", "Bearer") | ||
| .Build(); | ||
|
|
||
| await new GeneralClientBootstrap() | ||
| .SetConfig(config) | ||
| .LaunchAsync(); | ||
| ``` |
There was a problem hiding this comment.
This ConfiginfoBuilder “Quick Usage” snippet uses GeneralClientBootstrap but only imports GeneralUpdate.Common.Shared.Object; it will not compile without also importing the GeneralUpdate.ClientCore namespace (or fully-qualifying the type). Please make the snippet self-contained by adding the missing import.
| ``` | ||
|
|
||
| **UpdateInfoEventArgs Properties:** | ||
| - `Info`: `VersionRespDTO` — version response data from the server, containing the list of available versions and a `UpdateLog` field per version |
There was a problem hiding this comment.
Grammar: use “an UpdateLog field” (not “a UpdateLog field”) because UpdateLog starts with a vowel sound.
| - `Info`: `VersionRespDTO` — version response data from the server, containing the list of available versions and a `UpdateLog` field per version | |
| - `Info`: `VersionRespDTO` — version response data from the server, containing the list of available versions and an `UpdateLog` field per version |
| .AddListenerUpdateInfo((sender, e) => | ||
| { | ||
| foreach (var v in e.Info.Body ?? []) |
There was a problem hiding this comment.
The e.Info.Body ?? [] fallback uses C# collection expressions, which won’t compile on many setups (e.g., projects still using older C# for .NET 5/6). Consider using a more broadly compatible empty-sequence fallback so the sample compiles across the supported target versions.
| .AddListenerUpdateInfo((sender, e) => | |
| { | |
| foreach (var v in e.Info.Body ?? []) | |
| using System.Linq; | |
| .AddListenerUpdateInfo((sender, e) => | |
| { | |
| foreach (var v in e.Info.Body ?? Enumerable.Empty<VersionInfoDTO>()) |
| ```csharp | ||
| using GeneralUpdate.Common.Shared.Object; | ||
|
|
||
| // 零配置:从 .csproj 自动提取名称、版本、发布者 | ||
| var config = ConfiginfoBuilder | ||
| .Create("https://api.example.com/updates", "your-token", "Bearer") | ||
| .Build(); | ||
|
|
||
| await new GeneralClientBootstrap() | ||
| .SetConfig(config) | ||
| .LaunchAsync(); | ||
| ``` | ||
|
|
||
| ### 自定义覆盖 |
There was a problem hiding this comment.
This ConfiginfoBuilder “快速使用” snippet uses GeneralClientBootstrap but only imports GeneralUpdate.Common.Shared.Object; it will not compile without also importing the GeneralUpdate.ClientCore namespace (or fully-qualifying the type). Please make the snippet self-contained by adding the missing import.
|
|
||
|
|
||
|
|
||
| - ### 📍2026-01-06 10.0.0 | ||
|
|
There was a problem hiding this comment.
There is a stray leading - before the ### 📍2026-01-06 10.0.0 heading, which turns the heading into a list item and changes the rendering/indentation of that entire section. Please remove the leading dash (or otherwise normalize the formatting) so this release log matches the surrounding headings.
Syncs website documentation with recently merged PRs in
GeneralLibrary/GeneralUpdate. Updates applied consistently acrossdocs/(default/zh),i18n/zh-Hans/, andi18n/en/.GeneralUpdate.ClientCore
AddListenerUpdatePrecheck(Func<UpdateInfoEventArgs, bool>)— unified precheck replacing theAddListenerUpdateInfo+SetCustomSkipOptioncombo; callback receives full version info and returnstrueto skip.IsForciblyversions always proceed regardless.SetCustomSkipOption— deprecated and removed upstream.AddListenerUpdateInfo(Action<object, UpdateInfoEventArgs>)— fires immediately after version validation; eachVersionInfonow carriesUpdateLogfor release notes.UpdateOption.EnableSilentUpdate— opt-in background polling (every 20 min), silent package prep, updater launched on process exit.ConfiginfoBuildersection — zero-config builder requiring onlyUpdateUrl,Token,Scheme; auto-detects app name/version/publisher from.csprojand adapts to platform.DriverDirectorytoConfiginfo— propagated throughConfigurationMapper → ProcessInfo → PipelineContext → DrivelutionMiddleware.GeneralUpdate.Core
SetFieldMappings()— deleted upstream.Configinfo.DriverDirectory;DrivelutionMiddlewarehandles installation automatically with no extra bootstrap calls.DriverDirectorytoPacketclass — documents the field auto-populated byConfigurationMapperfromConfiginfo.DriverDirectory.Release log
2026-04-10entry covering all the above changes plus full lifecycleGeneralTracerinstrumentation and two bug fixes (DefaultCleanMatcher,BinaryHandlerorphaned temp files).docs/andi18n/en/; Chinese ini18n/zh-Hans/.Global documentation audit
.NET 10added to version compatibility tables across all component docs that only listed up to.NET 9:GeneralUpdate.Bowl,GeneralUpdate.Core,GeneralUpdate.Differential,GeneralUpdate.Drivelution,GeneralClient.OSS,UpgradeHub— all three file copies each.zh-Hans/GeneralTracer.md: version string9,10corrected to9, 10.