Skip to content

Commit 009342d

Browse files
JusterZhuclaude
JusterZhu
and
claude
authored
docs: define Docusaurus IA, sidebar structure, and i18n layout (#63)
- Rewrite sidebar.js with explicit logical grouping (Quick Start, Components, Tools, Infrastructure, OSS, Utilities, Guides, Release Log) - Add advanced cookbook placeholder structure with chapter outline - Update _category_.json labels and descriptions for all sections - Sync i18n current.json sidebar translations for zh-Hans and English - Mirror all _category_.json files in both i18n locale directories Closes #46 Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
1 parent 5a28077 commit 009342d

18 files changed

Lines changed: 288 additions & 95 deletions

File tree

‎website/docs/doc/_category_.json‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
2-
"label": "Doc",
3-
"position": 1,
2+
"label": "Components",
3+
"position": 2,
44
"link": {
55
"type": "generated-index",
6-
"description": "GeneralUpdate开源项目在线文档."
6+
"description": "GeneralUpdate 组件参考文档 — 涵盖 Core、Bowl、Differential、Drivelution 与 Extension 五大非固件组件。"
77
}
88
}

‎website/docs/guide/_category_.json‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
2-
"label": "Guide",
3-
"position": 1,
2+
"label": "Guides",
3+
"position": 7,
44
"link": {
55
"type": "generated-index",
6-
"description": "指南."
6+
"description": "平台与运维指南。"
77
}
88
}

‎website/docs/quickstart/Advanced cookbook.md‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
sidebar_position: 4
3+
title: 高级实战手册
4+
---
5+
6+
# GeneralUpdate 高级实战手册
7+
8+
> **目标读者**：已有基础使用经验的开发者，正在将 GeneralUpdate 集成到生产产品、CI/CD 流水线和企业级发布工作流中。
9+
10+
## 内容概览
11+
12+
本手册覆盖以下主题：
13+
14+
1. **生产更新架构设计** — Client、Upgrade、Server、OSS、Tools 与 CI 的整体拓扑
15+
2. **标准化发布物** — 应用程序包、补丁包、扩展包、OSS 配置的生成与版本管理
16+
3. **CI/CD 集成** — 在 GitHub Actions / 内部流水线中触发补丁生成
17+
4. **版本策略** — SemVer、分支发布、渐进式推送、强制更新、多版本顺序升级
18+
5. **差分策略** — 何时使用差分、删除文件处理、黑名单、大文件场景
19+
6. **可靠性设计** — Bowl 监控、备份、回滚、启动验证、日志收集
20+
7. **扩展系统** — Manifest 设计、扩展包发布、兼容性检查、依赖管理
21+
8. **驱动更新** — Drivelution 权限、签名、平台差异、回滚与重启策略
22+
9. **安全合规** — Hash 校验、认证下载、OSS 权限、发布审计
23+
10. **故障演练** — 模拟下载失败、文件锁定、启动崩溃、补丁损坏、权限不足
24+
25+
## 章节索引
26+
27+
各章节具体内容正在编写中，详见以下子页面：
28+
29+
> **状态说明**：本文档正在积极构建中。如果你已积累生产实战经验，欢迎通过 Issue 或 PR 贡献案例。

‎website/docs/quickstart/_category_.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
2-
"label": "Quik start",
2+
"label": "Quick Start",
33
"position": 1,
44
"link": {
55
"type": "generated-index",
6-
"description": "Quik start."
6+
"description": "快速入门与实战手册。"
77
}
88
}

‎website/docs/releaselog/_category_.json‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
2-
"label": "Release log",
3-
"position": 1,
2+
"label": "Release Log",
3+
"position": 8,
44
"link": {
55
"type": "generated-index",
6-
"description": "发布日志."
6+
"description": "GeneralUpdate 发布日志与版本路线。"
77
}
88
}

‎website/i18n/en/docusaurus-plugin-content-docs/current.json‎

Lines changed: 28 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -3,36 +3,40 @@
33
"message": "Next",
44
"description": "The label for version current"
55
},
6-
"sidebar.tutorialSidebar.category.Doc": {
7-
"message": "Doc",
8-
"description": "The label for category Doc in sidebar tutorialSidebar"
6+
"sidebar.tutorialSidebar.category.Quick Start": {
7+
"message": "Quick Start",
8+
"description": "The label for category Quick Start in sidebar tutorialSidebar"
99
},
10-
"sidebar.tutorialSidebar.category.Doc.link.generated-index.description": {
11-
"message": "GeneralUpdate开源项目在线文档.",
12-
"description": "The generated-index page description for category Doc in sidebar tutorialSidebar"
10+
"sidebar.tutorialSidebar.category.Advanced Cookbook": {
11+
"message": "Advanced Cookbook",
12+
"description": "The label for category Advanced Cookbook in sidebar tutorialSidebar"
1313
},
14-
"sidebar.tutorialSidebar.category.Guide": {
15-
"message": "Guide",
16-
"description": "The label for category Guide in sidebar tutorialSidebar"
14+
"sidebar.tutorialSidebar.category.Components": {
15+
"message": "Components",
16+
"description": "The label for category Components in sidebar tutorialSidebar"
1717
},
18-
"sidebar.tutorialSidebar.category.Guide.link.generated-index.description": {
19-
"message": "指南.",
20-
"description": "The generated-index page description for category Guide in sidebar tutorialSidebar"
18+
"sidebar.tutorialSidebar.category.Tools": {
19+
"message": "Tools",
20+
"description": "The label for category Tools in sidebar tutorialSidebar"
2121
},
22-
"sidebar.tutorialSidebar.category.Quik start": {
23-
"message": "Quik start",
24-
"description": "The label for category Quik start in sidebar tutorialSidebar"
22+
"sidebar.tutorialSidebar.category.Infrastructure": {
23+
"message": "Infrastructure",
24+
"description": "The label for category Infrastructure in sidebar tutorialSidebar"
2525
},
26-
"sidebar.tutorialSidebar.category.Quik start.link.generated-index.description": {
27-
"message": "Quik start.",
28-
"description": "The generated-index page description for category Quik start in sidebar tutorialSidebar"
26+
"sidebar.tutorialSidebar.category.OSS Update Mode": {
27+
"message": "OSS Update Mode",
28+
"description": "The label for category OSS Update Mode in sidebar tutorialSidebar"
2929
},
30-
"sidebar.tutorialSidebar.category.Release log": {
31-
"message": "Release log",
32-
"description": "The label for category Release log in sidebar tutorialSidebar"
30+
"sidebar.tutorialSidebar.category.Utilities": {
31+
"message": "Utilities",
32+
"description": "The label for category Utilities in sidebar tutorialSidebar"
3333
},
34-
"sidebar.tutorialSidebar.category.Release log.link.generated-index.description": {
35-
"message": "发布日志.",
36-
"description": "The generated-index page description for category Release log in sidebar tutorialSidebar"
34+
"sidebar.tutorialSidebar.category.Guides": {
35+
"message": "Guides",
36+
"description": "The label for category Guides in sidebar tutorialSidebar"
37+
},
38+
"sidebar.tutorialSidebar.category.Release Log": {
39+
"message": "Release Log",
40+
"description": "The label for category Release Log in sidebar tutorialSidebar"
3741
}
3842
}

‎website/i18n/en/docusaurus-plugin-content-docs/current/doc/_category_.json‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
2-
"label": "Doc",
3-
"position": 1,
2+
"label": "Components",
3+
"position": 2,
44
"link": {
55
"type": "generated-index",
6-
"description": "GeneralUpdate open source project online documentation."
6+
"description": "GeneralUpdate component reference — covering the five non-firmware components: Core, Bowl, Differential, Drivelution, and Extension."
77
}
88
}

‎website/i18n/en/docusaurus-plugin-content-docs/current/guide/_category_.json‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
2-
"label": "Guide",
3-
"position": 1,
2+
"label": "Guides",
3+
"position": 7,
44
"link": {
55
"type": "generated-index",
6-
"description": "Guide."
6+
"description": "Platform and operations guides."
77
}
88
}

‎website/i18n/en/docusaurus-plugin-content-docs/current/quickstart/Advanced cookbook.md‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
sidebar_position: 4
3+
title: Advanced cookbook
4+
---
5+
6+
# GeneralUpdate advanced cookbook
7+
8+
> **Target audience**: developers who have basic GeneralUpdate experience and are integrating it into production products, CI/CD pipelines, and enterprise release workflows.
9+
10+
## Overview
11+
12+
This cookbook covers:
13+
14+
1. **Production update architecture** — overall topology of Client, Upgrade, Server, OSS, Tools, and CI
15+
2. **Standardized release artifacts** — application packages, patch packages, extension packages, OSS configuration
16+
3. **CI/CD integration** — triggering patch generation in GitHub Actions / internal pipelines
17+
4. **Version strategy** — SemVer, branch releases, staged rollout, forced updates, multi-version sequential upgrades
18+
5. **Differential strategy** — when to use differential, handling deleted files, blacklists, large-file scenarios
19+
6. **Reliability design** — Bowl monitoring, backup, rollback, startup validation, log collection
20+
7. **Extension system** — manifest design, extension package publishing, compatibility, dependency management
21+
8. **Driver updates** — Drivelution permissions, signatures, platform differences, rollback and restart strategy
22+
9. **Security and compliance** — hash validation, authenticated downloads, OSS permissions, release audit
23+
10. **Failure drills** — simulate download failure, file lock, startup crash, corrupted patch, insufficient permissions
24+
25+
## Chapter index
26+
27+
Detailed content for each chapter is under active development. See the sub-pages below:
28+
29+
> **Status**: this document is under active construction. If you have production experience to share, PRs and issues are welcome.

‎website/i18n/en/docusaurus-plugin-content-docs/current/quickstart/_category_.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
2-
"label": "Quick start",
2+
"label": "Quick Start",
33
"position": 1,
44
"link": {
55
"type": "generated-index",
6-
"description": "Quick start."
6+
"description": "Quick start guides and hands-on cookbooks."
77
}
88
}

0 commit comments

Comments
 (0)