Conversation
|
@copilot Additional note: The code repository address for GeneralUpdate.Extension is as follows. https://github.com/GeneralLibrary/GeneralUpdate/tree/master/src/c%23/GeneralUpdate.Extension |
Co-authored-by: JusterZhu <11714536+JusterZhu@users.noreply.github.com>
Co-authored-by: JusterZhu <11714536+JusterZhu@users.noreply.github.com>
…tension management system Co-authored-by: JusterZhu <11714536+JusterZhu@users.noreply.github.com>
Thank you for the clarification! I've completely rewritten the documentation based on the actual GeneralUpdate.Extension source code from the repository you provided. The new documentation now accurately covers the VS Code-inspired extension management system, including:
Changes committed in: f178cf7 The documentation is now ready with both Chinese and English versions (750+ lines each) and has been successfully built with Docusaurus. |
Co-authored-by: JusterZhu <11714536+JusterZhu@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Adds new Docusaurus documentation pages for the GeneralUpdate.Extension plugin/extension management system, with localized variants intended for the site’s i18n structure.
Changes:
- Added a new GeneralUpdate.Extension documentation page under the main docs tree.
- Added localized documentation pages under
i18n/enandi18n/zh-Hans. - Updated
package-lock.json(adds"peer": truemetadata on multiple packages).
Reviewed changes
Copilot reviewed 3 out of 4 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| website/package-lock.json | Lockfile metadata changes (adds "peer": true on multiple entries). |
| website/docs/doc/GeneralUpdate.Extension.md | Adds the GeneralUpdate.Extension doc page (currently written in Chinese). |
| website/i18n/en/docusaurus-plugin-content-docs/current/docs/doc/GeneralUpdate.Extension.md | Adds the English localized doc page. |
| website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/doc/GeneralUpdate.Extension.md | Adds the zh-Hans localized doc page (Chinese). |
Files not reviewed (1)
- website/package-lock.json: Language not supported
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| using GeneralUpdate.Extension; | ||
| using GeneralUpdate.Extension.Core; | ||
| using GeneralUpdate.Extension.Common.Models; | ||
| using GeneralUpdate.Extension.Common.DTOs; |
There was a problem hiding this comment.
快速开始代码示例里使用了 TargetPlatform.Windows,但 using 列表里没有包含 TargetPlatform 所在的命名空间(你在后面的完整示例里有 using GeneralUpdate.Extension.Common.Enums;)。为了让新手复制即可运行,建议在该示例补充对应 using(或使用全限定名)。
| using GeneralUpdate.Extension.Common.DTOs; | |
| using GeneralUpdate.Extension.Common.DTOs; | |
| using GeneralUpdate.Extension.Common.Enums; |
| "version": "4.22.1", | ||
| "resolved": "https://registry.npmjs.org/@algolia/client-search/-/client-search-4.22.1.tgz", | ||
| "integrity": "sha512-yb05NA4tNaOgx3+rOxAmFztgMTtGBi97X7PC3jyNeGiwkAjOZc2QrdZBYyIdcDLoI09N0gjtpClcackoTN0gPA==", | ||
| "peer": true, |
There was a problem hiding this comment.
package-lock.json is being modified (adding "peer": true to many entries) without any corresponding change in package.json. This kind of lockfile churn is typically incidental (e.g., generated by a different npm version) and can make dependency installs inconsistent for other contributors/CI. Please either revert the lockfile-only changes, or include the exact npm/node version used and confirm the change is required to fix the docs build.
| "peer": true, |
| ### 定义 | ||
|
|
||
| 命名空间:GeneralUpdate.Extension | ||
|
|
||
| 程序集:GeneralUpdate.Extension.dll | ||
|
|
||
| **NuGet 包**:GeneralUpdate.Extension | ||
|
|
||
|
|
||
|
|
||
| GeneralUpdate.Extension 是一个受 VS Code 启发的 .NET 应用程序扩展管理系统。它提供完整的插件/扩展管理功能,包括扩展下载、安装、更新、版本兼容性检查、平台支持、依赖关系解析和回滚机制。 | ||
|
|
There was a problem hiding this comment.
This page under website/docs/ is written in Chinese, but the rest of website/docs/doc/ appears to be the English source docs with Chinese living under website/i18n/zh-Hans/... (e.g., website/docs/doc/GeneralUpdate.Core.md is English while website/i18n/zh-Hans/.../GeneralUpdate.Core.md is Chinese). As-is, this will make the default docs set contain mixed languages and also duplicates the same Chinese content already added under i18n/zh-Hans. Consider making website/docs/doc/GeneralUpdate.Extension.md the English version (matching the i18n/en content), and keeping the Chinese version only in i18n/zh-Hans.
| using GeneralUpdate.Extension; | ||
| using GeneralUpdate.Extension.Core; | ||
| using GeneralUpdate.Extension.Common.Models; | ||
| using GeneralUpdate.Extension.Common.DTOs; |
There was a problem hiding this comment.
The Quick Start snippet references TargetPlatform.Windows but doesn’t import the namespace where TargetPlatform is defined (you include using GeneralUpdate.Extension.Common.Enums; later in the full example). For beginners, this first snippet should be self-contained—please add the missing using (or fully-qualify TargetPlatform) so the sample compiles as shown.
| using GeneralUpdate.Extension.Common.DTOs; | |
| using GeneralUpdate.Extension.Common.DTOs; | |
| using GeneralUpdate.Extension.Common.Enums; |
Documentation for GeneralUpdate.Extension - a VS Code-inspired extension/plugin management system for .NET applications. Based on the actual component source code at https://github.com/GeneralLibrary/GeneralUpdate/tree/master/src/c%23/GeneralUpdate.Extension.
Changes
Created bilingual documentation (Chinese/English) following existing i18n structure:
/website/docs/doc/GeneralUpdate.Extension.md(Chinese)/website/i18n/en/docusaurus-plugin-content-docs/current/docs/doc/GeneralUpdate.Extension.md(English)/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/doc/GeneralUpdate.Extension.md(Chinese Simplified)Content coverage (750+ lines each):
Fixed MDX compilation: Escaped generic types (Task<bool>, List<VersionInfo>) to prevent HTML tag parsing errors
Example Usage
Documentation follows existing component patterns and is beginner-focused with detailed explanations and practical examples for implementing plugin/extension systems in .NET applications.
Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.