Skip to content

doc: 重构 GeneralUpdate 五大组件文档 #78

Description

@JusterZhu

背景

重构 GeneralUpdate.Core、GeneralUpdate.Bowl、GeneralUpdate.Differential、GeneralUpdate.Drivelution、GeneralUpdate.Extension 五个组件的在线文档,统一为规范的六段式模板。

变更内容

文档结构统一

每个组件文档现在遵循以下 6 段式大纲:

章节 内容
1. 组件简介 核心能力表、业务痛点、业务场景
2. 组件功能列表 功能名称、描述、类型(基础/拓展)、是否必填、备注
3. API 配置说明 3 张独立表格:Props、实例方法、回调事件
4. 扩展示例 扩展点总览 + 多场景示例(场景说明→代码→注意事项)
5. 常规使用示例 快速入门 → 基础参数 → 真实业务落地
6. 全局配置 配置语法、优先级、平台差异

其他改进

  • 标题下方加入横排元信息(命名空间 | 主要入口 | NuGet 包)
  • 精简环境与依赖表格(移除与标题元信息重复的字段)
  • 移除所有 dotnet add package 命令行
  • UpgradeHub 内容合并到 GeneralUpdate.Core 文档
  • 侧边栏移除独立 UpgradeHub 条目

涉及文件

  • website/docs/doc/ 下 5 个组件文档(zh-Hans)
  • website/i18n/en/website/i18n/zh-Hans/ 下各 5 个翻译文档
  • website/sidebars.js

相关 PR

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions