docs: fix image paths and formatting in Chinese documentation#34
docs: fix image paths and formatting in Chinese documentation#34mhduiy merged 1 commit intolinuxdeepin:masterfrom
Conversation
Reviewer's GuideStandardizes image references and markdown formatting across Chinese DDE documentation variants (zh_CN, zh_TW, zh_HK), adding line breaks before images, converting Windows-style image paths to POSIX-style paths, and fixing one incorrect backup/restore image filename. Flow diagram for normalization of image references in Chinese documentationflowchart TD
A[Chinese_docs zh_CN zh_TW zh_HK] --> B[Existing_image_references]
B --> C{Issue_type}
C --> D[Windows_style_paths fig\p_license_activator_X.png]
C --> E[Missing_line_break_before_image]
C --> F[Incorrect_backup_restore_filename p_backuprestore.png]
D --> G[Convert_to_POSIX_paths fig/p_license_activator_X.png]
E --> H[Insert_blank_line_before_image]
F --> I[Update_filename_to_d_backup_restore.png]
G --> J[Standardized_image_paths]
H --> K[Improved_markdown_structure]
I --> L[Correct_image_file_reference]
J --> M[Rendered_docs_with_consistent_images]
K --> M
L --> M
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Hey - I've left some high level feedback:
- In
zh_CN/p_dde.md, the image paths still use backslashes (e.g.fig\p_license_activator_1.png), which is inconsistent with the stated goal of switching to forward slashes and with the changes ind_dde.md. - The indentation of image lines inside lists is now inconsistent across the zh_CN/zh_TW/zh_HK docs (some images are flush left, some have one or two leading spaces), which may change how Markdown renders them inside list items; consider normalizing indentation so list structure is clearly preserved.
- For several bullet points (e.g. the offline activation sections), images were moved from being under a
-list item to standalone lines, which may break the intended association between the bullet text and its image; please confirm and align the pattern across all three locale files.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- In `zh_CN/p_dde.md`, the image paths still use backslashes (e.g. `fig\p_license_activator_1.png`), which is inconsistent with the stated goal of switching to forward slashes and with the changes in `d_dde.md`.
- The indentation of image lines inside lists is now inconsistent across the zh_CN/zh_TW/zh_HK docs (some images are flush left, some have one or two leading spaces), which may change how Markdown renders them inside list items; consider normalizing indentation so list structure is clearly preserved.
- For several bullet points (e.g. the offline activation sections), images were moved from being under a `-` list item to standalone lines, which may break the intended association between the bullet text and its image; please confirm and align the pattern across all three locale files.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Fixed image file paths and improved markdown formatting in Chinese documentation files for better readability and consistency. Changed backslash path separators to forward slashes in image references to ensure cross-platform compatibility. Added proper line breaks before images to separate them from preceding text for clearer document structure. Updated the backup/restore image filename from p_backuprestore.png to d_backup_restore.png to match the actual file. docs: 修复中文文档中的图片路径和格式 修复了中文文档文件中的图片文件路径并改进了Markdown格式,以提高可读性和 一致性。将图片引用中的反斜杠路径分隔符改为正斜杠,以确保跨平台兼容性。在 图片前添加了适当的换行,以将图片与前面的文本分开,使文档结构更清晰。将备 份/恢复图片文件名从p_backuprestore.png更新为d_backup_restore.png以匹配实 际文件。 PMS: BUG-336869
deepin pr auto review这段代码 diff 主要涉及 Markdown 文档的格式调整和图片路径的修改。以下是针对语法逻辑、代码质量、代码性能和代码安全的详细审查意见: 1. 语法逻辑
2. 代码质量
3. 代码性能
4. 代码安全
总结与改进建议
总体而言,这次修改主要是为了修正路径格式和调整排版,只要确认图片脱离列表结构后的显示效果符合预期,即可合并。建议在合并前预览生成的文档(PDF 或 HTML),确保图片位置不会造成阅读困扰。 |
|
[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. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
Fixed image file paths and improved markdown formatting in Chinese documentation files for better readability and consistency. Changed backslash path separators to forward slashes in image references to ensure cross-platform compatibility. Added proper line breaks before images to separate them from preceding text for clearer document structure. Updated the backup/restore image filename from p_backuprestore.png to d_backup_restore.png to match the actual file.
docs: 修复中文文档中的图片路径和格式
修复了中文文档文件中的图片文件路径并改进了Markdown格式,以提高可读性和
一致性。将图片引用中的反斜杠路径分隔符改为正斜杠,以确保跨平台兼容性。在
图片前添加了适当的换行,以将图片与前面的文本分开,使文档结构更清晰。将备
份/恢复图片文件名从p_backuprestore.png更新为d_backup_restore.png以匹配实 际文件。
PMS: BUG-336869
Summary by Sourcery
Improve image references and formatting in Chinese DDE documentation pages for clearer structure and correct asset links.
Documentation: