Skip to content

docs: unify layout and style across 5 GeneralUpdate component docs#79

Merged
JusterZhu merged 1 commit into
mainfrom
docs/unify-component-doc-layout
Jun 3, 2026
Merged

docs: unify layout and style across 5 GeneralUpdate component docs#79
JusterZhu merged 1 commit into
mainfrom
docs/unify-component-doc-layout

Conversation

@JusterZhu

Copy link
Copy Markdown
Collaborator

Summary

Unifies the layout, style, and structure of 5 GeneralUpdate component documentation pages (Bowl, Core, Differential, Drivelution, Extension) across all 3 language versions (EN source, zh-Hans, en).

Problem

  1. zh-Hans Bowl: Had a stray ## 简介 heading at the top of the page — inconsistent with all other component docs
  2. zh-Hans Drivelution: Started with ### 定义 (H3) instead of proper H1 title + metadata section
  3. zh-Hans Extension: Used ## 组件概览 instead of the standard ## 1. 组件简介
  4. zh-Hans Core & Differential: Metadata fields were on separate lines instead of inline
  5. sidebar_position 12 duplicated between Drivelution and Extension
  6. Overall lack of visual consistency across sections, separators, and heading hierarchy

Changes

Structure fixes

  • zh-Hans Bowl: Removed ## 简介, restructured to standard 6-section template (1. 组件简介6. 全局配置)
  • zh-Hans Drivelution: Replaced ### 定义 with proper title + inline metadata + numbered sections
  • zh-Hans Extension: Replaced ## 组件概览 with ## 1. 组件简介### 1.1 组件概述
  • zh-Hans Core/Differential: Merged multi-line metadata into single inline line

sidebar_position fixes

  • Drivelution: 128 (all 3 language versions)
  • Extension: 127 (all 3 language versions)
  • Final sequence: Bowl(3) → Core(5) → Differential(6) → Extension(7) → Drivelution(8)

Visual polish

  • Consistent inline metadata format: **命名空间:** ... | **入口:** ... | **NuGet:** ...
  • Consistent --- separators between all major sections
  • Consistent heading hierarchy (H1 → H2 numbered → H3) across all pages

Files changed (9 files)

File Change
website/docs/doc/GeneralUpdate.Drivelution.md sidebar_position fix
website/docs/doc/GeneralUpdate.Extension.md sidebar_position fix
website/i18n/en/.../doc/GeneralUpdate.Drivelution.md sidebar_position fix
website/i18n/en/.../doc/GeneralUpdate.Extension.md sidebar_position fix
website/i18n/zh-Hans/.../doc/GeneralUpdate.Bowl.md Full restructure (remove ## 简介)
website/i18n/zh-Hans/.../doc/GeneralUpdate.Core.md Metadata inline
website/i18n/zh-Hans/.../doc/GeneralUpdate.Differential.md Metadata inline
website/i18n/zh-Hans/.../doc/GeneralUpdate.Drivelution.md Full restructure + sidebar
website/i18n/zh-Hans/.../doc/GeneralUpdate.Extension.md Full restructure + sidebar

After (unified template)

All 5 components in all 3 languages now follow:

---
sidebar_position: <unique>
---
# Component Name
**metadata line** (inline)

## 1. 组件简介 / Component Overview
### 1.1 组件概述 / Introduction
### 1.2 环境与依赖 / Environment & Dependencies
---
## 2. 组件功能列表 / Feature List
---
## 3. API 配置说明 / API Configuration
---
## 4. 扩展示例 / Advanced Examples
---
## 5. 常规使用示例 / Basic Usage
---
## 6. 全局配置 / Global Configuration
---
## 相关资源 / Related Resources

🤖 Generated with Claude Code

- Fix zh-Hans Bowl: remove stray '## 简介' heading, restructure to follow standard 6-section template
- Fix zh-Hans Drivelution: replace '### 定义' with proper title + metadata + numbered sections
- Fix zh-Hans Extension: replace '## 组件概览' with standard '## 1. 组件简介'
- Fix zh-Hans Core/Differential: merge multi-line metadata into single inline line
- Fix duplicate sidebar_position 12 between Drivelution and Extension (→ 8 and 7)
- Apply consistent formatting: inline metadata, --- separators, numbered sections (1-6) across all 5 components in all 3 languages (EN source, zh-Hans, en)

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings June 3, 2026 17:31
@JusterZhu JusterZhu removed the request for review from Copilot June 3, 2026 17:31
@JusterZhu JusterZhu self-assigned this Jun 3, 2026
@JusterZhu JusterZhu added the documentation Improvements or additions to documentation label Jun 3, 2026
@JusterZhu JusterZhu linked an issue Jun 3, 2026 that may be closed by this pull request
@JusterZhu JusterZhu merged commit 96d347f into main Jun 3, 2026
3 checks passed
@JusterZhu JusterZhu deleted the docs/unify-component-doc-layout branch June 9, 2026 04:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

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

1 participant