Skip to content

docs: 统一 5 个 GeneralUpdate 组件文档的布局与风格 #80

Description

@JusterZhu

问题描述

GeneralUpdate.Bowl、GeneralUpdate.Core、GeneralUpdate.Differential、GeneralUpdate.Drivelution、GeneralUpdate.Extension 五个组件文档的布局和风格存在以下不一致:

具体问题

  1. zh-Hans Bowl 页面:开头有一个孤立的 ## 简介 标题,其他组件文档都没有,非常突兀
  2. zh-Hans Drivelution 页面:第一个结构性标题是 ### 定义(三级标题),缺少正确的 H1 标题和元数据行
  3. zh-Hans Extension 页面:使用 ## 组件概览 而非标准的 ## 1. 组件简介
  4. zh-Hans Core 和 Differential:元数据(命名空间/入口/NuGet)分行书写,而非单行内联
  5. sidebar_position 12:Drivelution 和 Extension 重复使用同一位置值
  6. 各页面 --- 分隔线使用不一致,章节编号不规范

预期行为

  • 全部 5 个组件在全部 3 个语言版本中遵循统一的布局模板
  • sidebar_position 无重复,顺序合理

PR

涉及文件(9 个)

  • website/docs/doc/GeneralUpdate.Drivelution.md
  • website/docs/doc/GeneralUpdate.Extension.md
  • website/i18n/en/.../doc/GeneralUpdate.Drivelution.md
  • website/i18n/en/.../doc/GeneralUpdate.Extension.md
  • website/i18n/zh-Hans/.../doc/GeneralUpdate.Bowl.md
  • website/i18n/zh-Hans/.../doc/GeneralUpdate.Core.md
  • website/i18n/zh-Hans/.../doc/GeneralUpdate.Differential.md
  • website/i18n/zh-Hans/.../doc/GeneralUpdate.Drivelution.md
  • website/i18n/zh-Hans/.../doc/GeneralUpdate.Extension.md

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No fields configured for Task.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions