Add comprehensive repository documentation with bilingual README#34
Add comprehensive repository documentation with bilingual README#34
Conversation
Co-authored-by: JusterZhu <11714536+JusterZhu@users.noreply.github.com>
Co-authored-by: JusterZhu <11714536+JusterZhu@users.noreply.github.com>
Co-authored-by: JusterZhu <11714536+JusterZhu@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
This pull request adds comprehensive bilingual README documentation (English and Chinese) to the GeneralUpdate-Samples repository, replacing the minimal previous README. The documentation provides a complete guide to the repository's structure, purpose, and usage.
Changes:
- Added detailed bilingual README files (README.md and README_zh.md) with complete project documentation
- Documented 10 sample projects covering standard updates, OSS updates, differential updates, process monitoring, push notifications, compression, driver updates, and extensions
- Included quick start guides, code examples, environment requirements, and contribution guidelines
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
| README.md | Comprehensive English documentation including project overview, features, repository structure, quick start guides, sample project descriptions, UI framework examples, related repositories, requirements, and support information |
| README_zh.md | Chinese translation of the complete documentation, mirroring the English version's structure and content |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - 使用文件服务器上的 `version.json` 配置 | ||
| - 直接集成文件服务器(阿里云 OSS、AWS S3 等) | ||
| - 支持 AOT 编译 | ||
|
|
||
| **version.json 示例:** |
There was a problem hiding this comment.
The documentation refers to "version.json" but the actual implementation uses "versions.json" (plural). This should be updated to match the actual filename used in the codebase.
| - 使用文件服务器上的 `version.json` 配置 | |
| - 直接集成文件服务器(阿里云 OSS、AWS S3 等) | |
| - 支持 AOT 编译 | |
| **version.json 示例:** | |
| - 使用文件服务器上的 `versions.json` 配置 | |
| - 直接集成文件服务器(阿里云 OSS、AWS S3 等) | |
| - 支持 AOT 编译 | |
| **versions.json 示例:** |
| | Feature | Description | Sample Location | | ||
| |---------|-------------|----------------| | ||
| | **Standard Update** | Traditional client-server update mechanism | `src/Client`, `src/Server`, `src/Upgrade` | | ||
| | **OSS Update** | Simplified update using file server and version.json | `src/OSS` | | ||
| | **Differential Update** | Binary patch generation and application | `src/Diff` | | ||
| | **Process Monitoring** | Crash detection and diagnostic information export | `src/Bowl` | | ||
| | **Push Updates** | Real-time update notifications using SignalR | `src/Push` | | ||
| | **Compression** | Compression capability testing and debugging | `src/Compress` | | ||
| | **Driver Update** | Driver package update capabilities | `src/Drivelution` | | ||
| | **Extension** | Custom extension development examples | `src/Extension` | |
There was a problem hiding this comment.
The PR description states "Repository layout with 8 sample projects" but the documentation correctly lists 10 distinct sample projects: Client, Server, Upgrade, OSS (which contains 2 sub-samples), Bowl, Diff, Push, Compress, Drivelution, and Extension. The PR description should be updated to reflect the actual count of 10 sample projects, or if counting top-level directories only, it should be 9 (since OSS is one directory containing two samples).
| oss_start.cmd | ||
| ``` | ||
|
|
||
| This demonstrates OSS-based updates using only a `version.json` configuration file on a file server. |
There was a problem hiding this comment.
The documentation refers to "version.json" but the actual implementation uses "versions.json" (plural). This is evident in the Server code at src/Server/wwwroot/packages/versions.json and the OSS client code at src/OSS/OSSClientSample/Program.cs line 9. The documentation should be updated to use the correct filename "versions.json" throughout.
| This demonstrates OSS-based updates using only a `version.json` configuration file on a file server. | |
| This demonstrates OSS-based updates using only a `versions.json` configuration file on a file server. |
| - Uses `version.json` configuration on file server | ||
| - Direct file server integration (Alibaba Cloud OSS, AWS S3, etc.) | ||
| - Supports AOT compilation | ||
|
|
||
| **version.json Example:** |
There was a problem hiding this comment.
The documentation refers to "version.json" but the actual implementation uses "versions.json" (plural). This should be updated to match the actual filename used in the codebase.
| - Uses `version.json` configuration on file server | |
| - Direct file server integration (Alibaba Cloud OSS, AWS S3, etc.) | |
| - Supports AOT compilation | |
| **version.json Example:** | |
| - Uses `versions.json` configuration on file server | |
| - Direct file server integration (Alibaba Cloud OSS, AWS S3, etc.) | |
| - Supports AOT compilation | |
| **versions.json Example:** |
| oss_start.cmd | ||
| ``` | ||
|
|
||
| 这演示了基于 OSS 的更新,仅使用文件服务器上的 `version.json` 配置文件。 |
There was a problem hiding this comment.
The documentation refers to "version.json" but the actual implementation uses "versions.json" (plural). This should be updated to match the actual filename used in the codebase.
| 这演示了基于 OSS 的更新,仅使用文件服务器上的 `version.json` 配置文件。 | |
| 这演示了基于 OSS 的更新,仅使用文件服务器上的 `versions.json` 配置文件。 |
Repository lacked structured documentation for the sample collection. Added comprehensive README files in English and Chinese covering the GeneralUpdate automatic update framework samples.
Changes
Documentation Coverage
Standard Update Flow:
OSS Update (Simplified):
Uses
version.jsonon file server instead of server-side code - documented for developers choosing between update mechanisms.Each sample project documented with purpose, key features, and integration patterns. Website build instructions included for Docusaurus documentation site.
Original prompt
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.