Skip to content

chore: update dde manual content#32

Merged
mhduiy merged 1 commit intolinuxdeepin:masterfrom
mhduiy:manual
Jan 14, 2026
Merged

chore: update dde manual content#32
mhduiy merged 1 commit intolinuxdeepin:masterfrom
mhduiy:manual

Conversation

@mhduiy
Copy link
Contributor

@mhduiy mhduiy commented Jan 14, 2026

as title

Log: update dde manual content

as title

Log: update dde manual content
Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry @mhduiy, your pull request is larger than the review limit of 150000 diff characters

@deepin-ci-robot
Copy link

deepin pr auto review

我已经仔细审查了提供的git diff和代码变更,以下是我的详细评估和改进建议:

1. 语法逻辑审查

1.1 Markdown格式问题

  • 问题:部分表格列对齐不一致,如d_dde.md中的功能表格

    | Function          | Description                                                                 |
    |-------------------|-----------------------------------------------------------------------------|

    建议统一使用:

    | Function         | Description                                         |
    | ---------------- | --------------------------------------------------- |
  • 问题:部分章节标题层级不一致

    • 有些地方直接使用三级标题(###),有些地方使用四级标题(####)
    • 建议:统一使用四级标题作为子章节的开始

1.2 链接和引用问题

  • 问题:部分图片路径引用不一致
    ![1|clipboard](fig/clipboard.png)
    建议统一图片命名规范,避免使用1|这样的前缀

2. 代码质量审查

2.1 内容组织

  • 问题:部分章节内容重复
    • 例如"设置显示"和"显示设置"内容相似但分散在不同位置
    • 建议:合并相似内容,避免冗余

2.2 文本一致性

  • 问题:术语使用不统一
    • "剪贴板"和"Clipboard"混用
    • "任务栏"和"Dock"混用
    • 建议:建立术语表,统一术语使用

2.3 图片引用

  • 问题:部分图片文件名变更未完全同步
    -rename from src/assets/dde/en_US/fig/p_fullscreen.png
    +rename to src/assets/dde/en_US/fig/fullscreen.png
    建议:确保所有引用路径同步更新

3. 代码性能审查

3.1 文件大小

  • 问题:部分图片文件可能过大
    • 建议:优化图片压缩,使用WebP格式替代PNG

3.2 资源加载

  • 问题:大量图片可能导致文档加载缓慢
    • 建议:
      1. 实现图片懒加载
      2. 提供图片缩略图选项
      3. 考虑使用CDN分发静态资源

4. 代码安全审查

4.1 路径安全

  • 问题:部分路径包含特殊字符
    ![0sound](fig\sound.png)  # 使用了反斜杠
    建议:统一使用正斜杠/作为路径分隔符

4.2 敏感信息

  • 问题:部分示例包含可能敏感的信息
    /usr/share/applications
    建议:确保示例路径不包含实际系统敏感路径

5. 具体改进建议

5.1 文档结构优化

# 建议的新结构
## 桌面环境
### 概述
#### 系统简介
#### 主要功能

### 桌面
#### 基本操作
#### 文件管理
#### 显示设置

5.2 图片管理

# 建议的图片命名规范
fig/
├── desktop/
│   ├── overview.png
│   ├── contextmenu.png
│   └── clipboard.png
├── control-center/
│   ├── display.png
│   ├── sound.png
│   └── network.png

5.3 术语统一表

中文 英文 说明
桌面 Desktop 主屏幕区域
任务栏 Taskbar 底部应用栏
启动器 Launcher 应用启动器
控制中心 Control Center 系统设置

5.4 代码示例改进

# 改进前
1. Go to **System** > **Display**.
2. Select resolution from dropdown.

# 改进后
1. Open the Control Center
2. Navigate to **System** > **Display**
3. Select the desired resolution from the dropdown menu
4. Click **Apply** to confirm changes

6. 自动化建议

6.1 添加Markdown检查

# .markdownlint.yaml
MD001: false  # 允许标题层级
MD013: false  # 允许长行
MD033: false  # 允许HTML

6.2 图片优化脚本

# optimize-images.sh
#!/bin/bash
find fig/ -name "*.png" -exec pngquant --quality=80-90 --ext .png --force {} \;

7. 总结

主要改进点:

  1. 统一Markdown格式和文档结构
  2. 规范术语使用和图片命名
  3. 优化图片资源和加载性能
  4. 加强路径安全和内容审查
  5. 建立自动化检查流程

建议优先处理:

  • 术语统一问题
  • 图片路径同步
  • Markdown格式规范
  • 文档结构重组

这些改进将提高文档的可维护性、可读性和整体质量。

@deepin-ci-robot
Copy link

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: mhduiy, xionglinlin

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@mhduiy mhduiy merged commit 7e2c48b into linuxdeepin:master Jan 14, 2026
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants