Add comprehensive i18n documentation for GeneralUpdate core components#38
Add comprehensive i18n documentation for GeneralUpdate core components#38
Conversation
…ntent Co-authored-by: JusterZhu <11714536+JusterZhu@users.noreply.github.com>
Co-authored-by: JusterZhu <11714536+JusterZhu@users.noreply.github.com>
|
@copilot What I mean is that the online documentation in both Chinese and English should be written in i18n. |
Co-authored-by: JusterZhu <11714536+JusterZhu@users.noreply.github.com>
Co-authored-by: JusterZhu <11714536+JusterZhu@users.noreply.github.com>
…ial components Co-authored-by: JusterZhu <11714536+JusterZhu@users.noreply.github.com>
…ish in separate files Co-authored-by: JusterZhu <11714536+JusterZhu@users.noreply.github.com>
Done! I've restructured the documentation to follow proper i18n conventions. The bilingual documentation has been separated into:
Each language now has its own complete documentation files without mixed content. Commit: 67f5a14 Chinese Documentation (Default Locale): English Documentation (i18n/en): All four core components (Bowl, ClientCore, Core, Differential) now have separate Chinese and English versions following Docusaurus i18n best practices. |
There was a problem hiding this comment.
Pull request overview
This PR expands the Docusaurus documentation for the four GeneralUpdate core components (Bowl, ClientCore, Core, Differential) and adds Prism syntax highlighting support so the docs render well across zh-Hans (default) and en locales.
Changes:
- Rewrote/expanded docs for the 4 components with structured sections (Overview, Features, Quick Start, API Reference, Examples, Notes).
- Added/updated parallel doc sets for default (zh-Hans) and
i18n/en(English), plus updatedi18n/zh-Hanscopies. - Enabled Prism highlighting for
csharp,bash, andjsonindocusaurus.config.js.
Reviewed changes
Copilot reviewed 13 out of 13 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| website/docusaurus.config.js | Enables additional Prism languages for better code highlighting in docs. |
| website/docs/doc/GeneralUpdate.Bowl.md | Expanded default-locale Bowl documentation with API and examples. |
| website/docs/doc/GeneralUpdate.ClientCore.md | Expanded default-locale ClientCore documentation with API and examples. |
| website/docs/doc/GeneralUpdate.Core.md | Expanded default-locale Core documentation with API and examples. |
| website/docs/doc/GeneralUpdate.Differential.md | Expanded default-locale Differential documentation with API and examples. |
| website/i18n/en/docusaurus-plugin-content-docs/current/doc/GeneralUpdate.Bowl.md | Added/expanded English Bowl documentation mirroring default structure. |
| website/i18n/en/docusaurus-plugin-content-docs/current/doc/GeneralUpdate.ClientCore.md | Added/expanded English ClientCore documentation mirroring default structure. |
| website/i18n/en/docusaurus-plugin-content-docs/current/doc/GeneralUpdate.Core.md | Added/expanded English Core documentation mirroring default structure. |
| website/i18n/en/docusaurus-plugin-content-docs/current/doc/GeneralUpdate.Differential.md | Added/expanded English Differential documentation mirroring default structure. |
| website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/doc/GeneralUpdate.Bowl.md | Updated zh-Hans localized Bowl documentation copy. |
| website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/doc/GeneralUpdate.ClientCore.md | Updated zh-Hans localized ClientCore documentation copy. |
| website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/doc/GeneralUpdate.Core.md | Updated zh-Hans localized Core documentation copy. |
| website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/doc/GeneralUpdate.Differential.md | Updated zh-Hans localized Differential documentation copy. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ProductId = "2d974e2a-31e6-4887-9bb1-b4689e98c77a", | ||
| // 应用密钥(用于服务器验证) | ||
| AppSecretKey = "dfeb5833-975e-4afb-88f1-6278ee9aeff6" |
There was a problem hiding this comment.
The docs include hard-coded ProductId and AppSecretKey values that look like real identifiers/keys. Even in examples, please replace these with obvious placeholders (e.g., "your-product-id", "your-secret-key") and consider adding a note that secrets should come from secure configuration (env vars/user secrets) rather than being committed to source control.
| ProductId = "2d974e2a-31e6-4887-9bb1-b4689e98c77a", | |
| // 应用密钥(用于服务器验证) | |
| AppSecretKey = "dfeb5833-975e-4afb-88f1-6278ee9aeff6" | |
| ProductId = "your-product-id", | |
| // 应用密钥(用于服务器验证) | |
| AppSecretKey = "your-app-secret-key" // 实际项目中请从安全配置(环境变量、用户机密等)中读取,而不要硬编码或提交到版本库中 |
| // Product ID (for multi-product branch management) | ||
| ProductId = "2d974e2a-31e6-4887-9bb1-b4689e98c77a", | ||
| // App secret key (for server verification) | ||
| AppSecretKey = "dfeb5833-975e-4afb-88f1-6278ee9aeff6" | ||
| }; |
There was a problem hiding this comment.
The docs include hard-coded ProductId and AppSecretKey values that look like real identifiers/keys. Even in examples, please replace these with obvious placeholders (e.g., "your-product-id", "your-secret-key") and consider adding a note that secrets should come from secure configuration (env vars/user secrets) rather than being committed to source control.
| ProductId = "2d974e2a-31e6-4887-9bb1-b4689e98c77a", | ||
| // 应用密钥(用于服务器验证) | ||
| AppSecretKey = "dfeb5833-975e-4afb-88f1-6278ee9aeff6" |
There was a problem hiding this comment.
文档示例中硬编码了 ProductId 和 AppSecretKey(看起来像真实的标识/密钥)。即使是示例也建议替换为明确的占位符(如 "your-product-id"、"your-secret-key"),并补充提示:密钥应来自安全配置(环境变量/User Secrets 等),避免提交到仓库。
| ProductId = "2d974e2a-31e6-4887-9bb1-b4689e98c77a", | |
| // 应用密钥(用于服务器验证) | |
| AppSecretKey = "dfeb5833-975e-4afb-88f1-6278ee9aeff6" | |
| ProductId = "your-product-id", | |
| // 应用密钥(用于服务器验证) | |
| // 注意: 在实际应用中,请从安全配置(如环境变量、User Secrets 等)中读取密钥,避免将真实密钥提交到仓库。 | |
| AppSecretKey = "your-app-secret-key" |


Creates production-ready documentation for GeneralUpdate.Bowl, GeneralUpdate.ClientCore, GeneralUpdate.Core, and GeneralUpdate.Differential following Docusaurus i18n standards with separate Chinese and English files.
Changes
Documentation Enhancement (4 components)
docs/doc/andi18n/zh-Hans/i18n/en/Proper i18n Structure
docs/doc/(default locale) andi18n/zh-Hans/i18n/en/docusaurus-plugin-content-docs/current/doc/API Documentation
Configuration
docusaurus.config.jsScreenshots
Chinese Documentation (Default Locale):

English Documentation (i18n/en):

Example
Build verified: Both zh-Hans and en locales compile successfully with proper i18n structure.
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.