Skip to content

docs: update documentation formatting and content#40

Merged
wjyrich merged 1 commit intolinuxdeepin:masterfrom
mhduiy:dde
Apr 10, 2026
Merged

docs: update documentation formatting and content#40
wjyrich merged 1 commit intolinuxdeepin:masterfrom
mhduiy:dde

Conversation

@mhduiy
Copy link
Copy Markdown
Contributor

@mhduiy mhduiy commented Apr 10, 2026

Updated multiple documentation files (d_dde.md, p_dde.md) across English, Simplified Chinese, Traditional Chinese (Hong Kong), and Traditional Chinese (Taiwan) locales. Changes include formatting adjustments from markdown headings (######) to bold text (**) for subsection titles to improve readability and consistency. Clarified tip text for sound preview to specify clicking the play button. Removed the "Application Proxy" section entirely from all language versions, indicating this feature may have been deprecated or moved. Simplified timezone addition instructions by removing the map click option. Fixed heading levels in Chinese language sections (changed ###### to ##### for consistency). These updates ensure documentation accuracy and better user guidance.

docs: 更新文档格式和内容

更新了多个文档文件(d_dde.md, p_dde.md),涵盖英文、简体中文、繁体中文
(香港)和繁体中文(台湾)区域设置。更改包括将子章节标题从Markdown标题
(######)调整为粗体文本(**),以提高可读性和一致性。澄清了声音预览的提
示文本,指定为单击播放按钮。从所有语言版本中完全移除了“应用代理”部分,表
明此功能可能已被弃用或移动。通过移除地图点击选项简化了时区添加说明。修复
了中文语言部分的标题级别(将######更改为#####以保持一致性)。这些更新确
保了文档的准确性和更好的用户指导。

PMS: BUG-355911 BUG-353325

Summary by Sourcery

Update DDE user documentation across all supported locales to improve structure, clarity, and reflect current functionality.

Documentation:

  • Standardize subsection formatting from markdown headings to bold text for consistency across locales.
  • Clarify sound preview tips to explicitly reference the play button in all languages.
  • Simplify timezone configuration instructions by removing the map-click selection option.
  • Remove the deprecated Application/Application Proxy section from the network settings docs in every locale.
  • Align Chinese documentation heading levels for language/region and developer options sections to maintain a coherent hierarchy.

Updated multiple documentation files (d_dde.md, p_dde.md) across
English, Simplified Chinese, Traditional Chinese (Hong Kong), and
Traditional Chinese (Taiwan) locales. Changes include formatting
adjustments from markdown headings (######) to bold text (**) for
subsection titles to improve readability and consistency. Clarified
tip text for sound preview to specify clicking the play button. Removed
the "Application Proxy" section entirely from all language versions,
indicating this feature may have been deprecated or moved. Simplified
timezone addition instructions by removing the map click option. Fixed
heading levels in Chinese language sections (changed ###### to #####
for consistency). These updates ensure documentation accuracy and better
user guidance.

docs: 更新文档格式和内容

更新了多个文档文件(d_dde.md, p_dde.md),涵盖英文、简体中文、繁体中文
(香港)和繁体中文(台湾)区域设置。更改包括将子章节标题从Markdown标题
(######)调整为粗体文本(**),以提高可读性和一致性。澄清了声音预览的提
示文本,指定为单击播放按钮。从所有语言版本中完全移除了“应用代理”部分,表
明此功能可能已被弃用或移动。通过移除地图点击选项简化了时区添加说明。修复
了中文语言部分的标题级别(将######更改为#####以保持一致性)。这些更新确
保了文档的准确性和更好的用户指导。

PMS: BUG-355911 BUG-353325
@deepin-ci-robot
Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is NOT APPROVED

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

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

@sourcery-ai
Copy link
Copy Markdown

sourcery-ai bot commented Apr 10, 2026

Reviewer's Guide

This PR updates DDE user documentation across en_US, zh_CN, zh_HK, and zh_TW locales to standardize subsection formatting, clarify sound preview and timezone instructions, and remove the deprecated Application Proxy feature from all language variants.

File-Level Changes

Change Details Files
Standardize subsection titles from level-6 markdown headings to bold text and fix heading levels for language/region sections.
  • Replace ###### subsection titles with **...** inline bold styling in display, boot menu, touchpad gestures, input method, and keyboard shortcuts sections.
  • Adjust language/region-related headings from level-6 (######) to level-5 (#####) where they are true sub-sections, including developer options headings.
  • Ensure consistency of these heading/formatting changes across en_US, zh_CN, zh_HK, and zh_TW documentation variants.
src/assets/dde/en_US/d_dde.md
src/assets/dde/en_US/p_dde.md
src/assets/dde/zh_CN/d_dde.md
src/assets/dde/zh_CN/p_dde.md
src/assets/dde/zh_HK/d_dde.md
src/assets/dde/zh_HK/p_dde.md
src/assets/dde/zh_TW/d_dde.md
src/assets/dde/zh_TW/p_dde.md
Clarify system sound preview tip to explicitly reference the play button in all locales.
  • Update tip text under the System Sounds section to say the user can click the play button to preview sounds instead of the generic 'click to preview' wording.
  • Align phrasing across zh_CN, zh_HK, zh_TW, and en_US variants while preserving locale-specific wording.
src/assets/dde/en_US/d_dde.md
src/assets/dde/en_US/p_dde.md
src/assets/dde/zh_CN/d_dde.md
src/assets/dde/zh_CN/p_dde.md
src/assets/dde/zh_HK/d_dde.md
src/assets/dde/zh_HK/p_dde.md
src/assets/dde/zh_TW/d_dde.md
src/assets/dde/zh_TW/p_dde.md
Simplify timezone addition instructions by removing map-based selection option.
  • In the Date & Time sections, remove references to selecting timezones by clicking on a map, leaving only search-based selection.
  • Apply the same simplification across all Chinese and English documentation variants for consistency with current UI behavior.
src/assets/dde/en_US/d_dde.md
src/assets/dde/en_US/p_dde.md
src/assets/dde/zh_CN/d_dde.md
src/assets/dde/zh_CN/p_dde.md
src/assets/dde/zh_HK/d_dde.md
src/assets/dde/zh_HK/p_dde.md
src/assets/dde/zh_TW/d_dde.md
src/assets/dde/zh_TW/p_dde.md
Remove documentation for the Application Proxy feature from Network settings across all locales.
  • Delete the Application Proxy section heading and numbered steps from the Network chapter.
  • Remove associated notes about enabling 'Use Proxy' from the launcher context menu.
  • Ensure the Network Details section now directly follows the general proxy settings section.
src/assets/dde/en_US/d_dde.md
src/assets/dde/en_US/p_dde.md
src/assets/dde/zh_CN/d_dde.md
src/assets/dde/zh_CN/p_dde.md
src/assets/dde/zh_HK/d_dde.md
src/assets/dde/zh_HK/p_dde.md
src/assets/dde/zh_TW/d_dde.md
src/assets/dde/zh_TW/p_dde.md
Tighten and align wording in various interaction instructions (gestures, input methods, shortcuts) while keeping content intact.
  • Keep existing step sequences for touchpad gestures, input method management, and custom shortcuts but convert their sub-headings to the new bold style.
  • Make minor locale-specific wording tweaks where headings changed from full sentences to bold labels (e.g., "Gesture Settings", "Add Input Method", "Custom Shortcut").
src/assets/dde/en_US/d_dde.md
src/assets/dde/en_US/p_dde.md
src/assets/dde/zh_CN/d_dde.md
src/assets/dde/zh_CN/p_dde.md
src/assets/dde/zh_HK/d_dde.md
src/assets/dde/zh_HK/p_dde.md
src/assets/dde/zh_TW/d_dde.md
src/assets/dde/zh_TW/p_dde.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@wjyrich wjyrich merged commit 5afe872 into linuxdeepin:master Apr 10, 2026
15 checks passed
Copy link
Copy Markdown

@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.

Hey - I've left some high level feedback:

  • Subsection styling now mixes bold text (e.g., for brightness, boot options, input methods) with ##### headings (e.g., language/region and developer options); it’s worth double-checking whether this hierarchy is intentional so that navigation, generated TOCs, and visual structure remain consistent across all locales.
  • Since the Application/Application Proxy section is removed in every locale, consider briefly indicating where that functionality moved or that it’s no longer available, to avoid confusing users who may still look for it based on older releases or UI labels.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- Subsection styling now mixes bold text (e.g., for brightness, boot options, input methods) with `#####` headings (e.g., language/region and developer options); it’s worth double-checking whether this hierarchy is intentional so that navigation, generated TOCs, and visual structure remain consistent across all locales.
- Since the Application/Application Proxy section is removed in every locale, consider briefly indicating where that functionality moved or that it’s no longer available, to avoid confusing users who may still look for it based on older releases or UI labels.

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

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